Edit

Share via

UcmConnectorPdSourceCaps function (ucmmanager.h)

  • Article

Notifies the USB connector manager framework extension (UcmCx) with the power source capabilities of the connector.

Syntax

NTSTATUS UcmConnectorPdSourceCaps(
  [in] UCMCONNECTOR                Connector,
       UCM_PD_POWER_DATA_OBJECT [] Pdos,
  [in] UCHAR                       PdoCount
);

Parameters

[in] Connector

Handle to the connector object that the client driver received in the previous call to UcmConnectorCreate.

Pdos

A caller-allocated array of UCM_PD_POWER_DATA_OBJECT structures that describes the power source capabilities.

[in] PdoCount

Number of elements in the array specified by Pdos[].

Return value

UcmConnectorPdSourceCaps returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method can return an appropriate NTSTATUS value.

Remarks

If the connector (local connector) is the power source, the client driver can report the capabilities and changes to those capabilities to UcmCx by using UcmConnectorPdSourceCaps. If connector is a power sink, report the advertised capabilities received from partner by calling UcmConnectorPdPartnerSourceCaps. The client driver must call UcmConnectorPdPartnerSourceCaps each time the partner re-advertises its capabilities.

Requirements

Requirement Value
Minimum supported client Windows 10
Minimum supported server Windows Server 2016
Target Platform Windows
Minimum KMDF version 1.15
Minimum UMDF version 2.15
Header ucmmanager.h (include Ucmcx.h)
Library UcmCxstub.lib
IRQL PASSIVE_LEVEL

See also

UcmConnectorCreate