WinUsb_GetPipePolicy関数 (winusb.h)

WinUsb_GetPipePolicy関数は、デバイス上のエンドポイントに関連付けられている特定のパイプのポリシーを取得します。 これは同期操作です。

構文

BOOL WinUsb_GetPipePolicy(
  [in]      WINUSB_INTERFACE_HANDLE InterfaceHandle,
  [in]      UCHAR                   PipeID,
  [in]      ULONG                   PolicyType,
  [in, out] PULONG                  ValueLength,
  [out]     PVOID                   Value
);

パラメーター

[in] InterfaceHandle

パイプが関連付けられているエンドポイントを含むインターフェイスへの不透明なハンドル。

最初のインターフェイスのエンドポイントに関連付けられているパイプに対してクエリを実行するには、 WinUsb_Initializeによって返されるハンドルを使用します。 その他のすべてのインターフェイスでは、WinUsb_GetAssociatedInterfaceによって取得されたターゲット インターフェイスへのハンドル 使用します。

[in] PipeID

7 ビット アドレスと方向ビットで構成される 8 ビット値。 このパラメーターは、エンドポイント記述子の bEndpointAddress フィールドに対応します。

[in] PolicyType

取得するポリシー パラメーターを指定する ULONG 変数。 ポリシー パラメーターの現在の値は、 Value パラメーターを取得します。 パイプ ポリシーの動作の詳細については、「パイプ ポリシーの 変更のための WinUSB 関数」を参照してください。

[in, out] ValueLength

Value が指すバッファーのサイズ (バイト単位) へのポインター。 出力時に、 ValueLength は Value バッファーにコピーされたデータのサイズ (バイト単位) 受け取ります。

[out] Value

指定したパイプ ポリシー値を受け取るバッファーへのポインター。

戻り値

操作が 成功した場合、WinUsb_GetPipePolicy は TRUE を 返します。 それ以外の場合、このルーチンは FALSE を返し、呼び出し元は GetLastError を呼び出すことによってログに記録されたエラーを取得できます。

GetLastError は 、次のエラー コードを返すことができます。

リターン コード 説明
ERROR_INVALID_HANDLE
呼び出し元が InterfaceHandle パラメーターに NULL を渡しました。

要件

   
対象プラットフォーム ユニバーサル
Header winusb.h (Winusb.h を含む)
Library Winusb.lib
[DLL] Winusb.dll

関連項目

WinUSB

WinUSB 関数

パイプ ポリシー修正のための WinUSB 関数

WinUsb_Initialize

WinUsb_ReadPipe

WinUsb_WritePipe