Win32 API 日本語リファレンス
ホームStorage.Packaging.Opc › IOpcSignaturePartReferenceEnumerator

IOpcSignaturePartReferenceEnumerator

COM
IID80eb1561-8c77-49cf-8266-459b356ee99a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

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

解説(Remarks)

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

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

IOpcSignaturePartReferenceEnumerator インターフェイスポインターを取得するには、IOpcSignaturePartReferenceSet::GetEnumerator メソッドまたは IOpcDigitalSignature::GetSignaturePartReferenceEnumerator メソッドを呼び出します。

スレッドセーフティ

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

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

メソッド 4

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

vtbl 3 HRESULT MoveNext(BOOL* hasNext)

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

hasNextBOOL*out

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

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

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

戻り値

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

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

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

hasPreviousBOOL*out

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

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

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

戻り値

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

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

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

partReferenceIOpcSignaturePartReference**outIOpcSignaturePartReference インターフェイスポインターです。

戻り値

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

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

解説(Remarks)

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

スレッドセーフティ

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

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

vtbl 6 HRESULT Clone(IOpcSignaturePartReferenceEnumerator** copy)

現在の IOpcSignaturePartReferenceEnumerator インターフェイスポインターとそのすべての下位要素のコピーを作成します。

copyIOpcSignaturePartReferenceEnumerator**outIOpcSignaturePartReferenceEnumerator インターフェイスポインターのコピーへのポインターです。

戻り値

このメソッドは 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_IOpcSignaturePartReferenceEnumerator "{80EB1561-8C77-49CF-8266-459B356EE99A}"
#usecom global IOpcSignaturePartReferenceEnumerator IID_IOpcSignaturePartReferenceEnumerator "{}"
#comfunc global IOpcSignaturePartReferenceEnumerator_MoveNext      3 var
#comfunc global IOpcSignaturePartReferenceEnumerator_MovePrevious  4 var
#comfunc global IOpcSignaturePartReferenceEnumerator_GetCurrent    5 sptr
#comfunc global IOpcSignaturePartReferenceEnumerator_Clone         6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。