IDirectWriterLock
COM公式ドキュメント
IDirectWriterLock インターフェイスは、ダイレクトモードで開かれたルートストレージオブジェクトに対して、単一のライターが排他的な書き込みアクセスを取得できるようにしつつ、複数のリーダーによる同時アクセスを許可します。
メソッド 3
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
WaitForWriteAccess メソッドは、ストレージオブジェクトに対する排他的な書き込みアクセスを取得します。
| dwTimeout | DWORD | in | ストレージオブジェクトに対する排他的な書き込みアクセスを取得するまでに、このメソッドがブロックする時間をミリ秒単位で指定します。dwTimeout が 0 の場合、このメソッドは書き込み用の排他アクセスを待ってブロックしません。dwTimeout には、Platform SDK で定義されている INFINITE タイムアウトを指定できます。 |
戻り値
このメソッドは、次のいずれかの値を返すことがあります。
| リターンコード | 説明 |
|---|---|
| S_OK | 呼び出し元がストレージへの排他的な書き込みアクセスを正常に取得しました。 |
| S_FALSE | IDirectWriterLock::ReleaseWriteAccess を呼び出すことなく、このメソッドが再度呼び出されました。 |
| STG_E_INUSE | 排他的な書き込みアクセスを取得できないまま、指定したタイムアウトが経過しました。 |
解説(Remarks)
ストレージが STGM_READWRITE|STGM_SHARE_DENY_WRITE を指定してダイレクトモード (STGM_DIRECT) で開かれている場合、このメソッドを呼び出してストレージへの排他的な書き込みアクセスを取得できます。
ストレージをどのリーダーも開いていない場合、このメソッドはただちに戻ります。ストレージがまだ読み取り用に開かれている場合、このメソッドは指定した dwTimeout の間、または現在のリーダーがストレージを閉じるまでブロックします。
ReleaseWriteAccess メソッドは、以前に取得した書き込みロックを解放します。
戻り値
このメソッドは、次のいずれかの値を返すことがあります。
| リターンコード | 説明 |
|---|---|
| S_OK | 書き込みロックが正常に解放されました。 |
解説(Remarks)
ライターは、以前に IDirectWriterLock::WaitForWriteAccess を呼び出して取得したストレージオブジェクトへの排他アクセスを解放するために、このメソッドを呼び出します。
ライターがこのメソッドを呼び出した後は、次に IDirectWriterLock::WaitForWriteAccess を呼び出すまで、リーダーがストレージを再度開くことを安全に許可できます。
HaveWriteAccess メソッドは、書き込みロックが取得されているかどうかを示します。
戻り値
このメソッドは、次のいずれかの値を返すことがあります。
| リターンコード | 説明 |
|---|---|
| S_OK | ストレージオブジェクトは現在、書き込みアクセス用にロックされています。 |
| S_FALSE | ストレージオブジェクトは現在、書き込みアクセス用にロックされていません。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IDirectWriterLock "{0E6D4D92-6738-11CF-9608-00AA00680DB4}"
#usecom global IDirectWriterLock IID_IDirectWriterLock "{}"
#comfunc global IDirectWriterLock_WaitForWriteAccess 3 int
#comfunc global IDirectWriterLock_ReleaseWriteAccess 4
#comfunc global IDirectWriterLock_HaveWriteAccess 5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。