UcxStaticStreamsCreate function (ucxsstreams.h)

Article
02/22/2024

Creates a static streams object.

Syntax

NTSTATUS UcxStaticStreamsCreate(
  [in]           UCXENDPOINT            Endpoint,
                 PUCXSSTREAMS_INIT      *StaticStreamsInit,
  [in, optional] PWDF_OBJECT_ATTRIBUTES Attributes,
                 UCXSSTREAMS            *StaticStreams
);

Parameters

[in] Endpoint

A handle to the endpoint object that supports static streams. The client driver retrieved the handle in a previous call to UcxEndpointCreate.

StaticStreamsInit

A pointer to a UCXSSTREAMS_INIT structure that describes various configuration operations for creating the stream object. The driver specifies function pointers to its callback functions in this structure. This structure is managed by UCX.

[in, optional] Attributes

A pointer to a caller-allocated WDF_OBJECT_ATTRIBUTES structure that specifies attributes for the stream object.

StaticStreams

A pointer to a variable that receives a handle to the new stream object.

Return value

The method returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method might return one an appropriate NTSTATUS error code.

Remarks

The client driver for the host controller must call this method after the WdfDeviceCreate call. The parent of the new endpoint object is the endpoint object.

Typically, the client driver calls this method in its implementation of the EVT_UCX_USBDEVICE_ENDPOINT_ADD event callback.

Requirements

Requirement	Value
Minimum supported client	Windows 10
Target Platform	Windows
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	ucxsstreams.h (include Ucxclass.h, Ucxstreams.h)
IRQL	PASSIVE_LEVEL

Share via