IHostIoCompletionManager::GetHostOverlappedSize メソッド

[アーティクル]
08/09/2011

ホストが I/O 要求に追加するカスタムデータのサイズを取得します。

HRESULT GetHostOverlappedSize (
    [out] DWORD *pcbSize
);

パラメーター

pcbSize
[出力] 共通言語ランタイム (CLR: Common Language Runtime) が Win32 の OVERLAPPED オブジェクトのサイズの他に割り当てる必要があるバイト数へのポインター。

戻り値

HRESULT	説明
S_OK	GetHostOverlappedSize が正常に終了しました。
HOST_E_CLRNOTAVAILABLE	CLR がプロセスに読み込まれていません。または、CLR がマネージコードを実行できない状態か、呼び出しを正常に処理できない状態にあります。
HOST_E_TIMEOUT	呼び出しがタイムアウトしました。
HOST_E_NOT_OWNER	呼び出し元がロックを所有していません。
HOST_E_ABANDONED	ブロックされたスレッドまたはファイバーが待機しているイベントがキャンセルされました。
E_FAIL	未知の重大エラーが発生しました。メソッドから E_FAIL が返される場合、プロセス内で CLR を使用することはできません。ホストメソッドへの後続の呼び出しで、HOST_E_CLRNOTAVAILABLE が返されます。

解説

Windows プラットフォーム API へのすべての非同期 I/O 呼び出しは、ファイルポインターの位置などの情報を提供する Win32 の OVERLAPPED オブジェクトを使用します。状態を維持するために、非同期 I/O 呼び出しを行うアプリケーションは、通常、この構造体にカスタムデータを追加します。 GetHostOverlappedSize および IHostIoCompletionManager::InitializeHostOverlapped では、ホストがこのようなカスタムデータを含めることができます。

CLR は、GetHostOverlappedSize メソッドを呼び出して、ホストが OVERLAPPED オブジェクトに追加するカスタムデータのサイズを決定します。

メモ
GetHostOverlappedSize は 1 回だけ呼び出されます。ホストのカスタムデータは、すべての I/O 要求で同じサイズである必要があります。