FVIL メンバの簡易説明文の取得

Namespace: FVIL
Assembly: FVILbasic (in FVILbasic.dll) Version: 3.1.0.0 (3.1.0.17)

Syntax

C#
public static string GetDescription(
	string key
)
Visual Basic
Public Shared Function GetDescription ( 
	key As String
) As String

Parameters

key
Type: System..::..String
メンバを特定するキー (例: P:FVIL.CFviObject.ErrorCode)

Return Value

Type: String

キーに該当するメンバの簡略説明文を返します。

Remarks

この関数は、FVIL のインテリセンス用 XML ファイルから読み込んだ 各メンバ(クラスや関数等)の簡易説明文を取得するものです。 主にプロパティの CFviDescription 属性 (Description 属性の派生)で使用します。

この関数の管理対象になるメンバは下記の条件を満たした XML ファイルから抽出されたものに限ります。

  • FVCL 配置場所(GetDllPath()()()()) にあること。
  • FVIL プレフィックスが付加されていること。
  • CLI ドキュメント仕様の書式であること。

上記の条件が満たされている場合に下記のルールで抽出します。
  • member 要素の name 属性の値をキーとする。
  • summary 要素の値を簡易説明文とする。

この抽出処理は InitVisionLibrary()()()() の内部で行われます。

ローカライズする場合は、FVIL のインテリセンス用 XML ファイルを差し替えることで可能です。

See Also