HWN_CLIENT_SET_STATE callback

Description

Implemented by the client driver to set hardware notification component state. It is invoked when a user wants to change the state of a driver.

Parameters

Context [in]

Pointer to the client driver's context information. This memory space is available for use by the client driver. It is allocated as part of the framework object context space by WdfDeviceCreate. For more information, see HWN_CLIENT_REGISTRATION_PACKET and Framework Object Context Space.

Buffer [in]

Buffer of BufferLength bytes containing a HWN_HEADER structure including one or more HWN_SETTINGS structures that specify the hardware notifications to be set.

BufferLength [in]

The size of Buffer in bytes.

BytesWritten [out]

Pointer to a variable that indicates the number of bytes written by the function.

Return value

Return STATUS_SUCCESS if the operation succeeds. Otherwise, return an appropriate NTSTATUS error code.

Prototype

HWN_CLIENT_SET_STATE HwnClientSetState;

NTSTATUS HwnClientSetState(
  _In_  PVOID  Context,
  _In_  PVOID  Buffer,
  _In_  ULONG  BufferLength,
  _Out_ PULONG BytesWritten
)
{ ... }

typedef HWN_CLIENT_SET_STATE *PHWN_CLIENT_SET_STATE;

Remarks

Register your implementation of this callback function by setting the appropriate member of HWN_CLIENT_REGISTRATION_PACKET and then calling HwNRegisterClient.

See also

Hardware notifications support

Hardware notifications reference