ISdo
COMIDispatch (デュアル)comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
ISdo インターフェイスは、Server Data Objects (SDO) の情報を格納、取得、更新するために使用します。
メソッド 7
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
GetPropertyInfo メソッドは、指定したプロパティに対する ISdoPropertyInfo インターフェイスへのポインターを取得します。
| Id | INT | in | 既存のプロパティの ID を指定します。 |
| ppPropertyInfo | IUnknown** | out | 指定したプロパティに対する ISdoPropertyInfo インターフェイスのアドレスを受け取るポインターへのポインター。 |
戻り値
メソッドが成功した場合、戻り値は S_OK です。
メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。
解説(Remarks)
Server Data Objects (SDO) はこのメソッドを公開していますが、SDO を使用するうえでこのメソッドは必要ありません。
GetProperty メソッドは、指定したプロパティの値を取得します。
| Id | INT | in | 既存のプロパティの ID を指定します。 |
| pValue | VARIANT* | out | プロパティの値を格納する VARIANT へのポインター。 |
戻り値
メソッドが成功した場合、戻り値は S_OK です。
メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。
PutProperty メソッドは、指定したプロパティに値を設定します。
| Id | INT | in | 既存のプロパティの ID を指定します。 |
| pValue | VARIANT* | in | そのプロパティに設定する値を格納する VARIANT へのポインター。 |
戻り値
メソッドが成功した場合、戻り値は S_OK です。
メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。
解説(Remarks)
ISdo::PutProperty で値を設定した後、 ISdo::Apply を呼び出して変更を永続ストレージに書き込みます。
プロパティが READ_ONLY である場合、または値が無効な場合、このメソッドは失敗します。
ResetProperty メソッドは、指定したプロパティを既定値にリセットします。
| Id | INT | in | 既存のプロパティの ID を指定します。 |
戻り値
メソッドが成功した場合、戻り値は S_OK です。
メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。
解説(Remarks)
既定値を持つ IAS プロパティはごくわずかです。既定値を持たないプロパティをリセットした場合、E_INVALIDARG が返されます。Visual Basic では、「Function call is invalid」のようなエラーが返されます。
Apply メソッドは、ISdo::PutProperty メソッドの呼び出しによって行われた変更を永続ストレージに書き込みます。
戻り値
メソッドが成功した場合、戻り値は S_OK です。
メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。
解説(Remarks)
ISdo::PutProperty による変更を取り消すには、 ISdo::Restore を呼び出します。
Restore メソッドは、Server Data Objects (SDO) のプロパティ値を永続ストレージから再読み込みします。
戻り値
メソッドが成功した場合、戻り値は S_OK です。
メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。
解説(Remarks)
ISdo::PutProperty メソッドの呼び出しによって行われた変更を取り消すには、 Restore メソッドを使用します。
get__NewEnum メソッドは、Server Data Objects (SDO) のプロパティに対する IEnumVARIANT インターフェイスを取得します。
| ppEnumVARIANT | IUnknown** | out | 呼び出しが成功した場合に IUnknown インターフェイスポインターを指す、ポインターへのポインター。この IUnknown インターフェイスポインターの QueryInterface メソッドを使用して IEnumVARIANT インターフェイスを取得します。 |
戻り値
メソッドが成功した場合、戻り値は S_OK です。
メソッドが失敗した場合、戻り値は次のいずれかのエラーコードです。
解説(Remarks)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ISdo "{56BC53DE-96DB-11D1-BF3F-000000000000}" #usecom global ISdo IID_ISdo "{}" #comfunc global ISdo_GetPropertyInfo 7 int,sptr #comfunc global ISdo_GetProperty 8 int,var #comfunc global ISdo_PutProperty 9 int,var #comfunc global ISdo_ResetProperty 10 int #comfunc global ISdo_Apply 11 #comfunc global ISdo_Restore 12 #comfunc global ISdo_get__NewEnum 13 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ISdo "{56BC53DE-96DB-11D1-BF3F-000000000000}" #usecom global ISdo IID_ISdo "{}" #comfunc global ISdo_GetPropertyInfo 7 int,sptr #comfunc global ISdo_GetProperty 8 int,sptr #comfunc global ISdo_PutProperty 9 int,sptr #comfunc global ISdo_ResetProperty 10 int #comfunc global ISdo_Apply 11 #comfunc global ISdo_Restore 12 #comfunc global ISdo_get__NewEnum 13 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。