UsbPm_RetrieveConnectorState function (usbpmapi.h)

Retrieves the current state of a connector. Unlike connector properties, state information is dynamic, which can change at runtime.

Syntax

NTSTATUS UsbPm_RetrieveConnectorState(
  [In]  USBPM_CLIENT           ClientHandle,
  [In]  USBPM_CONNECTOR        ConnectorHandle,
  [Out] PUSBPM_CONNECTOR_STATE ConnectorState
);

Parameters

[In] ClientHandle

The handle that the client driver received in a previous call to UsbPm_Register.

[In] ConnectorHandle

The connector handle provided by Policy Manager when it calls the driver's implementation of EVT_USBPM_EVENT_CALLBACK. The handle is set in the EventData.ConnectorStateChange.ConnectorHandle member of the Params value.

[Out] ConnectorState

A pointer to a driver-provided USBPM_CONNECTOR_STATE structure that receives the connector state. Initialize the structure by calling USBPM_CONNECTOR_STATE_INIT.

Return value

Returns STATUS_SUCCESS if the operation succeeds. Otherwise, returns an appropriate NTSTATUS value.

Requirements

See also

UsbPm_Register

EVT_USBPM_EVENT_CALLBACK