WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT関数 (wdfrequest.h)

  • [アーティクル]

[KMDF と UMDF に適用]

WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT関数は、ドライバーのWDF_REQUEST_SEND_OPTIONS構造体にタイムアウト値を設定します。

構文

void WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT(
  [in, out] PWDF_REQUEST_SEND_OPTIONS Options,
  [in]      LONGLONG                  Timeout
);

パラメーター

[in, out] Options

ドライバーの WDF_REQUEST_SEND_OPTIONS 構造体へのポインター。

[in] Timeout

絶対または相対タイムアウト値。 詳細については、WDF_REQUEST_SEND_OPTIONS構造体の Timeout メンバーに 関するページ を参照してください。

戻り値

なし

解説

タイムアウト値を設定するには、ドライバーが WDF_REQUEST_SEND_OPTIONS_INIT を呼び出した後、WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUTを呼び出す必要があります。

WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT関数は、指定したタイムアウト値を、指定したWDF_REQUEST_SEND_OPTIONS構造体の Timeout メンバーに格納します。 また、構造体の Flags メンバーにWDF_REQUEST_SEND_OPTION_TIMEOUT フラグを設定します。

例

次のコード例では、 WDF_REQUEST_SEND_OPTIONS 構造体を初期化し、構造体のタイムアウト値を設定します。 (この例では 、 WDF_REL_TIMEOUT_IN_SEC を呼び出して、10 秒の相対的なタイムアウト値を指定します)。次に、 WDF_REQUEST_SEND_OPTIONS 構造体を WdfUsbTargetPipeWriteSynchronously への入力として使用します。

WDF_REQUEST_SEND_OPTIONS  syncReqOptions;

WDF_REQUEST_SEND_OPTIONS_INIT(
                              &syncReqOptions,
                              0
                              );
WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT(
                                     &syncReqOptions,
                                     WDF_REL_TIMEOUT_IN_SEC(10)
                                     );
status = WdfUsbTargetPipeWriteSynchronously(
                                            pipeHandle,
                                            NULL,
                                            &syncReqOptions,
                                            &writeBufDesc,
                                            NULL
                                            );

要件

要件 値
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.0
最小 UMDF バージョン 2.0
Header wdfrequest.h (Wdf.h を含む)

こちらもご覧ください

WDF_REQUEST_SEND_OPTIONS

WDF_REQUEST_SEND_OPTIONS_INIT