ホーム › Devices.DeviceAccess › IDeviceIoControl

IDeviceIoControl

COM

IID9eefe161-23ab-4f18-9b49-991b586ae970継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

デバイスドライバーに制御コードを送信します。これにより、デバイスは対応する操作を実行します。

メソッド 3

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

vtbl 3 HRESULT DeviceIoControlSync(DWORD ioControlCode, BYTE* inputBuffer, DWORD inputBufferSize, BYTE* outputBuffer, DWORD outputBufferSize, DWORD* bytesReturned)

DeviceIoControlSync メソッドは、CreateDeviceAccessInstance 関数の呼び出しで指定されたデバイスインターフェイスに対して、同期的なデバイス入出力 (I/O) 制御要求を送信します。

ioControlCode	DWORD	in	操作に対する I/O 制御コードです。
inputBuffer	BYTE*	inoptional	操作に対する入力バッファーです (省略可能)。
inputBufferSize	DWORD	in	入力バッファーのサイズ (バイト単位) です。
outputBuffer	BYTE*	outoptional	操作に対する出力バッファーです (省略可能)。
outputBufferSize	DWORD	in	出力バッファーのサイズ (バイト単位) です。
bytesReturned	DWORD*	out	出力バッファーが指定されている場合に、そのバッファーに書き込まれたバイト数を受け取る変数へのポインターです。

戻り値

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

解説(Remarks)

これは同期メソッドであるため、長時間ブロックされることを許容できないスレッドで使用してはいけません。そのような場合は DeviceIoControlAsync メソッドを使用します。

vtbl 4 HRESULT DeviceIoControlAsync(DWORD ioControlCode, BYTE* inputBuffer, DWORD inputBufferSize, BYTE* outputBuffer, DWORD outputBufferSize, IDeviceRequestCompletionCallback* requestCompletionCallback, UINT_PTR* cancelContext)

DeviceIoControlAsync メソッドは、CreateDeviceAccessInstance 関数の呼び出しで指定されたデバイスインターフェイスに対して、非同期のデバイス入出力 (I/O) 制御要求を送信します。

ioControlCode	DWORD	in	操作に対する I/O 制御コードです。
inputBuffer	BYTE*	inoptional	操作に対する入力バッファーです (省略可能)。
inputBufferSize	DWORD	in	入力バッファーのサイズ (バイト単位) です。
outputBuffer	BYTE*	outoptional	操作に使用する出力バッファーです。
outputBufferSize	DWORD	in	出力バッファーのサイズ (バイト単位) です。
requestCompletionCallback	IDeviceRequestCompletionCallback*	in	操作の送信が成功した場合に RequestCompletion メソッドが呼び出されるコールバックインターフェイスです。
cancelContext	UINT_PTR*	outoptional	未完了の要求を取り消すために CancelOperation メソッドへ渡すことができるキャンセルコンテキストを受け取るポインターです (省略可能)。

戻り値

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

解説(Remarks)

要求の送信が成功した場合 (つまり、この関数の呼び出しが直ちにエラーを返さなかった場合)、操作の結果は、指定した IDeviceRequestCompletionCallback インターフェイスの RequestCompletion コールバックで取得できます。

システム (オペレーティングシステムまたはデバイスドライバー) が即座に失敗させた操作については、コールバックは呼び出されません。つまり、呼び出し元がコールバックを受け取るのは、この関数が S_OK を返した場合のみです。

vtbl 5 HRESULT CancelOperation(UINT_PTR cancelContext)

CancelOperation メソッドは、DeviceIoControlAsync メソッドによって以前に発行された呼び出しの取り消しを試みます。

cancelContext

UINT_PTR

以前の DeviceIoControlAsync の呼び出しが返したキャンセルコンテキストです。

戻り値

このメソッドは、標準の戻り値に加えて次の値をサポートします。

戻り値	説明
S_OK	操作はまだ未完了であり、取り消しが試みられました。
ERROR_NOT_FOUND	操作は既に未完了ではありませんでした。

解説(Remarks)

取り消しが成功したかどうかにかかわらず、操作の結果は非同期呼び出しに指定したコールバックで取得できます。

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