GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION回呼函式 (gpioclx.h)

發行項
02/26/2024

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回呼函式應該設定CLIENT_CONTROLLER_BASIC_INFORMATION結構的所有成員，包括 Version 和 Size 成員。 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的詳細資訊，請參閱標註函式行為。