ITocEntryList
COM公式ドキュメント
ITocEntryList インターフェイスは、目次内のエントリのリストを表します。リストへのエントリの追加、およびリストからのエントリの削除を行うメソッドを提供します。
メソッド 5
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
GetEntryCount メソッドは、リスト内のエントリ数を取得します。
| pdwEntryCount | DWORD* | inout | エントリ数を受け取る DWORD へのポインター。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、以下の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 |
GetEntryByIndex メソッドは、インデックスで指定されたエントリをリストから取得します。
| dwEntryIndex | DWORD | in | 取得するエントリのインデックス。 |
| ppEntry | ITocEntry** | out | エントリを表す ITocEntry インターフェイスへのポインターを受け取る変数へのポインター。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、以下の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 |
AddEntry メソッドは、個々のエントリをリストに追加し、そのエントリにインデックスを割り当てます。
| pEntry | ITocEntry* | in | 追加するエントリを表す ITocEntry インターフェイスへのポインター。 |
| pdwEntryIndex | DWORD* | inout | 追加されたエントリのインデックスを受け取る DWORD へのポインター。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、以下の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 |
AddEntryByIndex メソッドは、個々のエントリをリストに追加し、呼び出し元が指定したインデックスをそのエントリに関連付けます。
| dwEntryIndex | DWORD | in | 追加するエントリのインデックス。 |
| pEntry | ITocEntry* | in | 追加するエントリを表す ITocEntry インターフェイスへのポインター。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、以下の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 |
RemoveEntryByIndex メソッドは、インデックスで指定されたエントリをリストから削除します。
| dwEntryIndex | DWORD | in | 削除するエントリのインデックス。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、以下の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ITocEntryList "{3A8CCCBD-0EFD-43A3-B838-F38A552BA237}" #usecom global ITocEntryList IID_ITocEntryList "{}" #comfunc global ITocEntryList_GetEntryCount 3 var #comfunc global ITocEntryList_GetEntryByIndex 4 int,sptr #comfunc global ITocEntryList_AddEntry 5 sptr,var #comfunc global ITocEntryList_AddEntryByIndex 6 int,sptr #comfunc global ITocEntryList_RemoveEntryByIndex 7 int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITocEntryList "{3A8CCCBD-0EFD-43A3-B838-F38A552BA237}" #usecom global ITocEntryList IID_ITocEntryList "{}" #comfunc global ITocEntryList_GetEntryCount 3 sptr #comfunc global ITocEntryList_GetEntryByIndex 4 int,sptr #comfunc global ITocEntryList_AddEntry 5 sptr,sptr #comfunc global ITocEntryList_AddEntryByIndex 6 int,sptr #comfunc global ITocEntryList_RemoveEntryByIndex 7 int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。