UcxEndpointGetStaticStreamsReferenced function (ucxendpoint.h)

Returns a referenced static streams object for the specified endpoint.

Syntax

UCXSSTREAMS UcxEndpointGetStaticStreamsReferenced(
  [in] UCXENDPOINT Endpoint,
  [in] PVOID       Tag
);

Parameters

[in] Endpoint

A handle to the endpoint object for which the static streams object is requested. The client driver retrieved the handle in a previous call to UcxEndpointCreate.

[in] Tag

A driver-defined value that the framework stores as an identification tag for the object reference.

Return value

A handle to the stream object if it is opened with the endpoint. Otherwise, NULL.

Remarks

The client driver can use this function to determine whether it has created a streams object for this endpoint. If it create the object the method returns the UCXSSTREAMS handle. The method returns NULL if the object was not created, or if the client driver failed the framework request object passed in the EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE callback. Any call to this method must be matched by a call to WdfObjectDereferenceWithTag by using the same Tag.

Requirements

See also

UcxEndpointCreate