次の方法で共有

SerCx2PioReceiveCreate 関数 (sercx.h)

  • [アーティクル]

SerCx2PioReceiveCreate メソッドは、PIO 受信オブジェクトを作成します。これは、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 が PIO 受信トランザクションを実行するために使用します。

構文

NTSTATUS SerCx2PioReceiveCreate(
  [in]           WDFDEVICE                  Device,
  [in]           PSERCX2_PIO_RECEIVE_CONFIG PioReceiveConfig,
  [in, optional] PWDF_OBJECT_ATTRIBUTES     Attributes,
  [out]          SERCX2PIORECEIVE           *PioReceive
);

パラメーター

[in] Device

シリアル コントローラーを表すフレームワーク デバイス オブジェクトへの WDFDEVICE ハンドル。 シリアル コントローラー ドライバーは、EvtDriverDeviceAdd コールバック関数でこのオブジェクトを作成しました。 詳細については、「SerCx2InitializeDevice」を参照してください。

[in] PioReceiveConfig

SERCX2_PIO_RECEIVE_CONFIG 構造体へのポインター。 このメソッドを呼び出す前に、呼び出し元は SERCX2_PIO_RECEIVE_CONFIG_INIT 関数を呼び出して構造体を初期化する必要があります。 この構造体には、シリアル コントローラー ドライバーによって実装されるイベント コールバック ルーチンのセットへのポインターが含まれています。 SerCx2 は、PIO 受信トランザクションを実行するためにこれらの関数を呼び出します。

[in, optional] Attributes

新しい PIO 受信オブジェクトに割り当てる属性を記述する WDF_OBJECT_ATTRIBUTES 構造体へのポインター。 このメソッドを呼び出す前に、呼び出し元は WDF_OBJECT_ATTRIBUTES_INIT 関数を呼び出して構造体を初期化する必要があります。 このパラメーターは省略可能であり、シリアル コントローラー ドライバーがオブジェクトに属性を割り当てる必要がない場合は、WDF_NO_OBJECT_ATTRIBUTESとして指定できます。 詳細については、「解説」を参照してください。

[out] PioReceive

このメソッドが新しく作成した PIO 受信オブジェクトに SERCX2PIORECEIVE ハンドルを書き込む場所へのポインター。 SerCx2 とシリアル コントローラー ドライバーは、このオブジェクトを参照する後続の呼び出しでこのハンドルを使用します。

戻り値

このメソッドは、呼び出しが成功した場合にSTATUS_SUCCESSを返します。 考えられるエラー戻り値には、次の状態コードが含まれます。

リターン コード 形容
STATUS_INVALID_DEVICE_REQUEST
 前の SerCx2PioReceiveCreate 呼び出しから PIO 受信オブジェクトが既に存在します。
STATUS_INFO_LENGTH_MISMATCH
 ConfigSize 値が sizeof(SERCX2_PIO_RECEIVE_CONFIG) 等しくありません。
STATUS_INVALID_PARAMETER
 実装されているコールバック関数の指定された組み合わせが無効です。 ドライバーは、EvtSerCx2PioReceiveReadBuffer、EvtSerCx2PioReceiveEnableReadyNotification、および EvtSerCx2PioReceiveCancelReadyNotification 関数を実装する必要があります。
STATUS_INSUFFICIENT_RESOURCES
 要求された操作を実行するために使用できるリソースが不足しています。

備考

シリアル コントローラー ドライバーは、PIO 受信オブジェクトを作成するには、このメソッドを呼び出します。 SerCx2 は、このオブジェクトを使用して PIO 受信トランザクションを実行します。このトランザクションでは、プログラムされた I/O (PIO) を使用してシリアル コントローラーが受信したデータを読み取ります。

通常、シリアル コントローラー ドライバーは、EvtDriverDeviceAdd 関数から SerCx2PioReceiveCreate を呼び出します。 ドライバーは、SerCx2InitializeDevice メソッドを正常に呼び出した後にのみ、このメソッドを呼び出す必要があります。

オプションとして、シリアル コントローラー ドライバーは、Attributes パラメーターを使用して PIO 受信オブジェクトのコンテキストを作成し、EvtCleanupCallback へのポインターを提供し、EvtDestroyCallback 関数を してオブジェクトを削除する準備を行うことができます。 詳細については、WDF_OBJECT_ATTRIBUTESを参照してください。

属性 パラメーターが WDF_OBJECT_ATTRIBUTES 構造体を指している場合、呼び出し元は、WDF_OBJECT_ATTRIBUTES_INIT 初期化関数が ParentObject、ExecutionLevel、およびこの構造体の SynchronizationScope メンバーに書き込む値を上書きしてはなりません。

PIO 受信オブジェクトの作成の詳細については、SERCX2PIORECEIVEを参照してください。 PIO 受信トランザクションの詳細については、「SerCx2 PIO-Receive Transactions」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows 8.1以降で使用できます。
ターゲット プラットフォーム の 万国
ヘッダー sercx.h
IRQL <= DISPATCH_LEVEL

関連項目

EvtCleanupCallback を する

EvtDestroyCallback の

EvtDriverDeviceAdd の

SERCX2PIORECEIVE

SERCX2_PIO_RECEIVE_CONFIG

SERCX2_PIO_RECEIVE_CONFIG_INIT

SerCx2InitializeDevice の

WDF_OBJECT_ATTRIBUTES

WDF_OBJECT_ATTRIBUTES_INIT