Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 3.17 KB

nf-ucmmanager-ucmconnectordatadirectionchanged.md

File metadata and controls

78 lines (60 loc) · 3.17 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:ucmmanager.UcmConnectorDataDirectionChanged
UcmConnectorDataDirectionChanged function (ucmmanager.h)
Notifies the USB connector manager framework extension (UcmCx) with the new data role of a change in data role.
buses\ucmconnectordatadirectionchanged.htm
usbref
01/05/2022
UcmConnectorDataDirectionChanged function
UcmConnectorDataDirectionChanged, UcmConnectorDataDirectionChanged method [Buses], buses.ucmconnectordatadirectionchanged, ucmmanager/UcmConnectorDataDirectionChanged
ucmmanager.h
Ucmcx.h
Windows
Windows 10
Windows Server 2016
1.15
2.15
UcmCxstub.lib
PASSIVE_LEVEL
Windows
UcmConnectorDataDirectionChanged
ucmmanager/UcmConnectorDataDirectionChanged
APIRef
kbSyntax
COM
UcmCxstub.lib
UcmCxstub.dll
UcmConnectorDataDirectionChanged

UcmConnectorDataDirectionChanged function

-description

Notifies the USB connector manager framework extension (UcmCx) with the new data role of a change in data role.

-parameters

-param Connector [in]

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

-param Success [in]

Used to indicate failure of a data-role swap that was initiated by UcmCx using EVT_UCM_CONNECTOR_SET_DATA_ROLE.

If TRUE, the operation was successful. FALSE, otherwise.

-param CurrentDataRole [in]

A UCM_TYPEC_PARTNER value that indicates the new data role.

-remarks

UcmConnectorDataDirectionChanged returns STATUS_SUCCESS if the operation succeeds. Otherwise, this inline function can return an appropriate NTSTATUS value.

If the connector partner is attached, UcmCx updates the data role of the partner depending on the CurrentDataRole value. For example, if the client driver changes the data role to UcmTypeCPortStateUfp, UcmCx updates the role of the connector partner to UcmTypeCPortStateDfp.

UcmCx can change the data role of a connector, and invokes EVT_UCM_CONNECTOR_SET_DATA_ROLE. In response to that call, the client should perform the DR_Swap operation, and indicate success/failure of the operation by calling UcmConnectorDataDirectionChanged.

Alternatively, the client driver might choose to perform a role-swap autonomously, or the partner might perform a role-swap. In either case, when the role-swap has completed, the driver must report the new role to UcmCx using UcmConnectorDataDirectionChanged.

-see-also