ホーム › Storage.Packaging.Opc › IOpcRelationshipEnumerator

IOpcRelationshipEnumerator

COM

IID42195949-3b79-4fc8-89c6-fc7fb979ee76継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IOpcRelationship インターフェイスポインターの読み取り専用の列挙子です。

解説(Remarks)

このインターフェイスへのポインターを取得するには、IOpcRelationshipSet::GetEnumerator メソッドまたは IOpcRelationshipSet::GetEnumeratorForType メソッドを呼び出します。

列挙子が作成された時点では、現在位置は最初のポインターの手前にあります。現在位置を列挙子の最初のポインターに設定するには、列挙子の作成後に MoveNext メソッドを呼び出してください。

注意セットに変更が加えられると列挙子は無効になり、以降の呼び出しはすべて失敗します。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

メソッド 4

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT MoveNext(BOOL* hasNext)

列挙子の現在位置を次の IOpcRelationship インターフェイスポインターへ移動します。

hasNext

BOOL*

out

現在位置にある IOpcRelationship インターフェイスポインターの状態を示すブール値です。

hasNext の値は、メソッドが成功した場合にのみ有効です。

値	意味
TRUE	列挙子の現在位置が次のポインターへ進み、そのポインターは有効です。
FALSE	列挙子の現在位置がコレクションの末尾を越えて進んだため、有効ではありません。

戻り値

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

リターンコード/値	説明
S_OK	メソッドは成功しました。
E_POINTER	hasNext パラメーターが NULL です。
OPC_E_ENUM_CANNOT_MOVE_NEXT 0x80510051	現在位置は既に列挙子の最後の項目を越えています。
OPC_E_ENUM_COLLECTION_CHANGED 0x80510050	基になるセットが変更されたため、列挙子は無効です。

解説(Remarks)

列挙子が作成された時点では、現在位置は最初のポインターの手前にあります。現在位置を列挙子の最初のポインターに設定するには、列挙子の作成後に MoveNext メソッドを呼び出してください。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

vtbl 4 HRESULT MovePrevious(BOOL* hasPrevious)

列挙子の現在位置を前の IOpcRelationship インターフェイスポインターへ移動します。

hasPrevious

BOOL*

out

現在位置にある IOpcRelationship インターフェイスポインターの状態を示すブール値です。

hasPrevious の値は、メソッドが成功した場合にのみ有効です。

値	意味
TRUE	列挙子の現在位置がコレクション内の前のポインターへ移動し、そのポインターは有効です。
FALSE	列挙子の現在位置が列挙子の先頭を越えて移動したため、有効ではありません。

戻り値

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

リターンコード/値	説明
S_OK	メソッドは成功しました。
E_POINTER	hasPrevious パラメーターが NULL です。
OPC_E_ENUM_COLLECTION_CHANGED 0x80510050	基になるセットが変更されたため、列挙子は無効です。
OPC_E_ENUM_CANNOT_MOVE_PREVIOUS 0x80510052	現在位置は既に列挙子の最初の項目の手前にあります。

解説(Remarks)

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

vtbl 5 HRESULT GetCurrent(IOpcRelationship** relationship)

列挙子の現在位置にある IOpcRelationship インターフェイスポインターを取得します。

relationship

IOpcRelationship**

out

IOpcRelationship インターフェイスポインターです。

戻り値

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

リターンコード/値	説明
S_OK	メソッドは成功しました。
E_POINTER	partReference パラメーターが NULL です。
OPC_E_ENUM_COLLECTION_CHANGED 0x80510050	基になるセットが変更されたため、列挙子は無効です。
OPC_E_ENUM_INVALID_POSITION 0x80510053	列挙子は現在位置からこの操作を実行できません。

解説(Remarks)

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

vtbl 6 HRESULT Clone(IOpcRelationshipEnumerator** copy)

現在の列挙子とそのすべての下位要素のコピーを作成します。(IOpcRelationshipEnumerator.Clone)

copy

IOpcRelationshipEnumerator**

out

新しい列挙子の IOpcRelationshipEnumerator インターフェイスへのポインターです。

戻り値

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

リターンコード/値	説明
S_OK	メソッドは成功しました。
E_POINTER	copy パラメーターが NULL です。
OPC_E_ENUM_COLLECTION_CHANGED 0x80510050	基になるセットが変更されたため、列挙子は無効です。

解説(Remarks)

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IOpcRelationshipEnumerator "{42195949-3B79-4FC8-89C6-FC7FB979EE76}"
#usecom global IOpcRelationshipEnumerator IID_IOpcRelationshipEnumerator "{}"
#comfunc global IOpcRelationshipEnumerator_MoveNext      3 var
#comfunc global IOpcRelationshipEnumerator_MovePrevious  4 var
#comfunc global IOpcRelationshipEnumerator_GetCurrent    5 sptr
#comfunc global IOpcRelationshipEnumerator_Clone         6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IOpcRelationshipEnumerator "{42195949-3B79-4FC8-89C6-FC7FB979EE76}"
#usecom global IOpcRelationshipEnumerator IID_IOpcRelationshipEnumerator "{}"
#comfunc global IOpcRelationshipEnumerator_MoveNext      3 sptr
#comfunc global IOpcRelationshipEnumerator_MovePrevious  4 sptr
#comfunc global IOpcRelationshipEnumerator_GetCurrent    5 sptr
#comfunc global IOpcRelationshipEnumerator_Clone         6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。