Edit

Share via

UCX_ENDPOINT_EVENT_CALLBACKS_INIT function (ucxendpoint.h)

  • Article

Initializes a UCX_ENDPOINT_EVENT_CALLBACKS structure with client driver's callback functions. The client driver calls this function before calling UcxEndpointCreate method to create an endpoint and register its callback functions with UCX.

Syntax

void UCX_ENDPOINT_EVENT_CALLBACKS_INIT(
  [out] PUCX_ENDPOINT_EVENT_CALLBACKS           Callbacks,
  [in]  PFN_UCX_ENDPOINT_PURGE                  EvtEndpointPurge,
  [in]  PFN_UCX_ENDPOINT_START                  EvtEndpointStart,
  [in]  PFN_UCX_ENDPOINT_ABORT                  EvtEndpointAbort,
  [in]  PFN_UCX_ENDPOINT_RESET                  EvtEndpointReset,
  [in]  PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS EvtEndpointOkToCancelTransfers,
  [in]  PFN_UCX_ENDPOINT_STATIC_STREAMS_ADD     EvtEndpointStaticStreamsAdd,
  [in]  PFN_UCX_ENDPOINT_STATIC_STREAMS_ENABLE  EvtEndpointStaticStreamsEnable,
  [in]  PFN_UCX_ENDPOINT_STATIC_STREAMS_DISABLE EvtEndpointStaticStreamsDisable
);

Parameters

[out] Callbacks

A pointer to a UCX_ENDPOINT_EVENT_CALLBACKS structure that contains pointers to the client driver's event callback functions.

[in] EvtEndpointPurge

A pointer to client driver's implementation of the EVT_UCX_ENDPOINT_PURGE event callback function.

[in] EvtEndpointStart

A pointer to client driver's implementation of the EVT_UCX_ENDPOINT_START event callback function.

[in] EvtEndpointAbort

A pointer to client driver's implementation of the EVT_UCX_ENDPOINT_ABORT event callback function.

[in] EvtEndpointReset

A pointer to client driver's implementation of the EVT_UCX_ENDPOINT_RESET event callback function.

[in] EvtEndpointOkToCancelTransfers

A pointer to client driver's implementation of the EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS event callback function.

[in] EvtEndpointStaticStreamsAdd

A pointer to client driver's implementation of the EVT_UCX_ENDPOINT_STATIC_STREAMS_ADD event callback function.

[in] EvtEndpointStaticStreamsEnable

A pointer to client driver's implementation of the EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE event callback function.

[in] EvtEndpointStaticStreamsDisable

A pointer to client driver's implementation of the EVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE event callback function.

Return value

None

Requirements

Requirement Value
Minimum supported client Windows 10
Target Platform Windows
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header ucxendpoint.h (include Ucxclass.h)

See also

UcxEndpointCreate