2.2 クラスおよびメソッドの記述形式

この節では,それぞれのクラスおよびメソッドで説明する項目の記述形式について示します。

各クラスの説明では,そのクラスで定義されるメソッドについてだけ説明しています。上位のクラスで定義されているメソッドについては,定義元のクラスを参照してください。

スーパークラス
最上位からそのクラスまでの継承関係とともにスーパークラスを概念図で示しています。
プロパティ一覧
クラスライブラリで定義されているプロパティ一覧を記述しています。
プロパティ一覧の例を次の表に示します。

表2-2 プロパティ一覧の例

プロパティ名プロパティ識別子データ型読み取り専用
XdbrProp_XInteger32
プロパティ名
プロパティの名称を記述しています。
プロパティ識別子
プロパティのシステムIDを記述しています。
データ型
プロパティのデータ型について記述しています。
読み取り専用
読み取り専用のプロパティか編集できるプロパティかを記述しています。
○:読み取り専用のプロパティであることを示します。
-:編集できるプロパティであることを示します。
プロパティ詳細
各プロパティ値の詳細について説明しています。上位のクラスから継承されたプロパティについては,プロパティ名だけを記述しています。上位のクラスから継承されたプロパティの値の詳細については,継承元のプロパティ詳細を参照してください。
なお,DMAで規定されているプロパティについては,「付録B DMAオブジェクトのプロパティ」を参照してください。
メソッド一覧
上位のクラスから継承されるメソッドおよびそのクラスで導入されるメソッドを,クラス別に表形式で示しています。
 

クラスの説明に続けて,そのクラスで導入されるメソッドをメソッド名のアルファベット順に説明しています。上位のクラスから継承されるメソッドの詳細については,継承元クラスのメソッドの説明を参照してください。

機能
メソッドの概要を説明しています。
形式
メソッドの形式を説明しています。
詳細
メソッドの機能の詳細について説明しています。
引数
引数について次のように説明しています。
引数(入力)
指定する値について説明しています。
引数(出力)
指定した領域に設定される値について説明しています。
  • 引数は「形式」で記述した文字列です。
  • 省略可能であることを明記していない引数(構造体)は,すべて指定する必要があります。
  • (入力)は,クライアントが値を指定することを示しています。
  • (出力)は,DocumentBrokerによって設定される値を格納する領域をクライアントが指定することを示しています。
戻り値
メソッドをコールした結果として返されるコードについて説明しています。
戻り値の詳細
戻り値が「DMA_FALSE」の場合に設定される,詳細な内容を示すコードについて説明しています。なお,戻り値の詳細には,major_codeとminor_codeが設定されます。コードの体系については,「付録H 戻り値一覧」を参照してください。