Win32 API 日本語リファレンス
ホームSystem.WinRT.Storage › IUnbufferedFileHandleProvider

IUnbufferedFileHandleProvider

COM
IIDa65c9109-42ab-4b94-a7b1-dd2e4e68515e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

StorageFile.OpenAsync メソッドが作成したランダムアクセスバイトストリームからハンドルへのアクセスを提供します。

メソッド 2

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

vtbl 3 HRESULT OpenUnbufferedFileHandle(IUnbufferedFileHandleOplockCallback* oplockBreakCallback, UINT_PTR* fileHandle)

StorageFile.OpenAsync メソッドが作成したランダムアクセスバイトストリームからハンドルを取得し、そのハンドルの便宜的ロック(oplock)が破棄されたときに実行するコールバックメソッドを登録します。

oplockBreakCallbackIUnbufferedFileHandleOplockCallback*inハンドルの便宜的ロック(oplock)が破棄されたときに実行したい IUnbufferedFileHandleOplockCallback::OnBrokenCallback メソッドの実装を含むインターフェイス。
fileHandleUINT_PTR*outランダムアクセスバイトストリームからのハンドル。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

IUnbufferedFileHandleProvider::OpenUnbufferedFileHandle は、GENERIC_READ 用に開かれた新しいハンドルを開きます。IUnbufferedFileHandleProvider::OpenUnbufferedFileHandle は、ストリームの基になる実際のハンドルや、そのハンドルの複製を返すことはありません。

ハンドルが不要になったら IUnbufferedFileHandleProvider::CloseUnbufferedFileHandle を呼び出してください。便宜的ロックが破棄されたときにもハンドルは閉じられるため、ハンドルが有効でないときに発生する例外をコードで処理する必要があります。

vtbl 4 HRESULT CloseUnbufferedFileHandle()

IUnbufferedFileHandleProvider::OpenUnbufferedFileHandle を呼び出して作成した、ランダムアクセスバイトストリームからのハンドルを閉じます。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUnbufferedFileHandleProvider "{A65C9109-42AB-4B94-A7B1-DD2E4E68515E}"
#usecom global IUnbufferedFileHandleProvider IID_IUnbufferedFileHandleProvider "{}"
#comfunc global IUnbufferedFileHandleProvider_OpenUnbufferedFileHandle   3 sptr,var
#comfunc global IUnbufferedFileHandleProvider_CloseUnbufferedFileHandle  4
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。