UcmUcsiConnectorCollectionCreate function (ucmucsippm.h)

Article
02/22/2024

Creates a connector collection object with UcmUcsiCx.

Syntax

NTSTATUS UcmUcsiConnectorCollectionCreate(
  [in]  WDFDEVICE                    WdfDevice,
  [in]  PWDF_OBJECT_ATTRIBUTES       Attributes,
  [out] UCMUCSI_CONNECTOR_COLLECTION *ConnectorCollection
);

Parameters

[in] WdfDevice

A handle to a framework device object that the client driver received in the previous call to WdfDeviceCreate.

[in] Attributes

A pointer to a caller-supplied WDF_OBJECT_ATTRIBUTES structure that contains attributes for the new connector collection object. This parameter is optional and can be WDF_NO_OBJECT_ATTRIBUTES.

[out] ConnectorCollection

A pointer to a location that receives a handle to the new connector collection object.

Return value

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

Remarks

The collection object is required for creating a Platform Policy Manager (PPM) object. The client driver creates the object by calling UcmUcsiPpmCreate. The driver must not call [UcmUcsiConnectorCollectionCreate] after UcmUcsiPpmCreate because it would have no effect on the already existing PPM object.

The connector collection object is parented to the WDFOBJECT even when UcmUcsiConnectorCollectionCreate is called by passing WDF_NO_ATTRIBUTES. The lifetime of the object is manager by the framework.

Requirements

Requirement	Value
Minimum KMDF version	1.27
Minimum UMDF version	N/A
Header	ucmucsippm.h (include UcmUcsiCx.h)
Library	UcmUcsiCxStub.lib
IRQL	PASSIVE_LEVEL