Skip to content

Latest commit

 

History

History
132 lines (98 loc) · 4.32 KB

nf-gpioclx-gpio_clx_registerclient.md

File metadata and controls

132 lines (98 loc) · 4.32 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:gpioclx.GPIO_CLX_RegisterClient
GPIO_CLX_RegisterClient function (gpioclx.h)
The GPIO_CLX_RegisterClient method registers a general-purpose I/O (GPIO) controller driver as a client of the GPIO framework extension (GpioClx).
gpio\gpio_clx_registerclient.htm
GPIO
02/15/2018
GPIO_CLX_RegisterClient function
GPIO.gpio_clx_registerclient, GPIO_CLX_RegisterClient, GPIO_CLX_RegisterClient method [Parallel Ports], gpioclx/GPIO_CLX_RegisterClient
gpioclx.h
Universal
Available starting with Windows 8.
Msgpioclxstub.lib
PASSIVE_LEVEL
Windows
GPIO_CLX_RegisterClient
gpioclx/GPIO_CLX_RegisterClient
APIRef
kbSyntax
LibDef
Msgpioclxstub.lib
Msgpioclxstub.dll
GPIO_CLX_RegisterClient

GPIO_CLX_RegisterClient function

-description

The GPIO_CLX_RegisterClient method registers a general-purpose I/O (GPIO) controller driver as a client of the GPIO framework extension (GpioClx).

-parameters

-param Driver [in]

A WDFDRIVER handle to the framework driver object for the GPIO controller driver.

-param RegistrationPacket [in, out]

A pointer to a caller-allocated GPIO_CLIENT_REGISTRATION_PACKET structure that contains the caller's registration information. This structure contains pointers to the event callback functions that the GPIO controller driver implements. Additionally, this structure specifies the size of the device context that the GPIO controller driver requires for its internal configuration data and state information.

-param RegistryPath [in]

A pointer to a UNICODE_STRING structure that contains the path name of the registry key for the GPIO controller driver. This parameter should be the registry path name that was passed to the driver's DriverEntry routine. For more information about driver registry keys, see Registry Trees for Devices and Drivers.

-returns

GPIO_CLX_RegisterClient returns STATUS_SUCCESS if the call is successful. Possible return values include the following error codes.

Return code Description
STATUS_INVALID_PARAMETER
The Driver, RegistrationPacket, or RegistryPath parameter is NULL.
STATUS_GPIO_INVALID_REGISTRATION_PACKET
The specified registration packet is not valid.
STATUS_INSUFFICIENT_RESOURCES
Out of memory.

-remarks

The GPIO controller driver calls this method to register its event callback functions with GpioClx. Typically, the driver calls this method from its DriverEntry routine, which runs shortly after the driver is loaded into memory.

Later, just before the GPIO controller driver unloads, the driver calls the GPIO_CLX_UnregisterClient method to cancel its registration with GpioClx.

-see-also

DriverEntry

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_UnregisterClient

UNICODE_STRING