次の方法で共有

GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION コールバック関数 (gpioclx.h)

  • [アーティクル]

CLIENT_QueryControllerBasicInformation イベント コールバック関数は、汎用 I/O (GPIO) コントローラーのハードウェア属性を取得します。

構文

GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION GpioClientQueryControllerBasicInformation;

NTSTATUS GpioClientQueryControllerBasicInformation(
  [in]  PVOID Context,
  [out] PCLIENT_CONTROLLER_BASIC_INFORMATION Information
)
{...}

パラメーター

[in] Context

GPIO コントローラー ドライバーの デバイス コンテキストへのポインター。

[out] Information

呼び出し元によって割り当てられた CLIENT_CONTROLLER_BASIC_INFORMATION 構造体へのポインター。 CLIENT_QueryControllerBasicInformation 関数は、GPIO コントローラーのハードウェア属性と構成情報をこの構造体に書き込みます。

戻り値

CLIENT_QueryControllerBasicInformation 関数は、呼び出しが成功した場合にSTATUS_SUCCESSを返します。 それ以外の場合は、適切なエラー コードが返されます。

備考

このコールバック関数は、GPIO コントローラー ドライバーによって実装されます。 GPIO フレームワーク拡張機能 (GpioClx) はこの関数を呼び出します。

CLIENT_QueryControllerBasicInformation コールバック関数は、Version メンバーや Size メンバーを含む、CLIENT_CONTROLLER_BASIC_INFORMATION 構造体のすべてのメンバーを設定する必要があります。 GpioClx は、この関数を呼び出す前に Size メンバーを初期化しませんが、Information パラメーターが指すバッファーは、GPIO コントローラー ドライバーが使用するこの構造体のバージョンを格納するのに十分な大きさであることが保証されます。

ドライバーの CLIENT_QueryControllerBasicInformation コールバック関数を登録するには、GPIO_CLX_RegisterClient メソッドを呼び出します。 このメソッドは、入力パラメーターとして、CLIENT_QueryControllerBasicInformation 関数ポインターを含む GPIO_CLIENT_REGISTRATION_PACKET 構造体へのポインターを受け取ります。

例

CLIENT_QueryControllerBasicInformation コールバック関数を定義するには、まず、定義するコールバック関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー のコード分析、静的ドライバー検証ツール (SDV)、およびその他の検証ツールをすると、エラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。

たとえば、MyEvtGpioQueryControllerBasicInformationという名前の CLIENT_QueryControllerBasicInformation コールバック関数を定義するには、次のコード例に示すように、GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION関数型を使用します。

GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION MyEvtGpioQueryDeviceInformation;

次に、次のようにコールバック関数を実装します。

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioQueryDeviceInformation(
    PVOID Context,
    PCLIENT_CONTROLLER_BASIC_INFORMATION Information
    )
{ ... }

GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION関数の種類は、Gpioclx.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations 注釈により、ヘッダー ファイル内のGPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「KMDF ドライバーの関数ロール型を使用して関数を宣言する」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows 8 以降でサポートされています。
ターゲット プラットフォーム の デスクトップ
ヘッダー gpioclx.h
IRQL PASSIVE_LEVELで呼び出されます。

関連項目

CLIENT_CONTROLLER_BASIC_INFORMATION

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient