APIは、そのAPIの命名ルールを関数、定数、およびデータ型に使用します。APIの今後のリリースとの互換性を確保するためには、プログラムでこれらの定数とデータ型の宣言を使用してください:
関数名- 関数が実行するアクションについて記述します。名前は、インタフェースを表す接頭辞で始まり、アクションとその対象について記述する1つ以上の語句が続きます。名前の各部分はスペースで分割せず、解釈しやすいように大文字を使用します。名前は次のフォーマットに従います:
|
名前のフォーマットと構成要素 |
例 |
|---|---|
|
InterfaceVerbObject |
Interface |
|
プログラミング・インタフェース |
EssCreateGroup |
|
Ess = C API |
EssUpdate = C API |
|
Esb = Visual Basic API |
EsbUpdate = Visual Basic API |
|
EssOtl = CアウトラインAPI |
EssOtlOpenOutline = CアウトラインAPI |
|
EsbOtl = Visual BasicアウトラインAPI |
EsbOtlOpenOutline = Visual BasicアウトラインAPI |
|
EssG = CグリッドAPI |
EssGSetGridOption = CグリッドAPI |
|
Verb 実行するアクション(「Report」など) |
EssReportFile (動詞の指定なし)は、レポートを送信します |
|
Object。アクションの対象(「Group」など) |
EssUpdate (オブジェクトの指定なし)は、現在のオブジェクトで実行されます |
データ構造体名- インタフェースを表す接頭辞で始まり、構造体について記述する語句を含んで、typedef定義またはマクロを示す接尾辞で終わります。アンダースコア文字が、名前の各部分を分割します。名前は次のフォーマットに従います:
|
名前のフォーマットと構成要素 |
例 |
|---|---|
|
Interface_Name_Type |
Interface |
|
プログラミング・インタフェース(ESSまたはESB) |
EssCreateGroup |
|
Verbデータ型。STR (文字列)など。 |
ESB_BOOL_T = Visual Basicに対する、Boolean型のtypdef |
|
Type構造体のタイプ。T(typedef定義)またはM(マクロ)のいずれか。 |
ESS_STR_T = C言語の文字列型のtypedef |
C API定数名 - Cのインタフェースを表す接頭辞ESSから始まり、定数について説明する単語を含み、接尾辞はありません。アンダースコア文字が、名前の各部分を分割します。名前は次のフォーマットに従います:
|
名前のフォーマットと構成要素 |
例 |
|---|---|
|
Structureデータ型または構造体フィールド。(「Boolean」など) |
ESS_Structure_Value |
|
Value。定数に保管する値のタイプ |
ESS_STS_NOERRORは、ESS_STS_Tデータ型の値を保管できます |