UcmTcpciPortControllerCreate function (ucmtcpciportcontroller.h)

  • Article

Creates a port controller object to register with UcmTcpciCx.

Syntax

NTSTATUS UcmTcpciPortControllerCreate(
  WDFDEVICE                        WdfDevice,
  PUCMTCPCI_PORT_CONTROLLER_CONFIG Config,
  PWDF_OBJECT_ATTRIBUTES           Attributes,
  UCMTCPCIPORTCONTROLLER           *PortControllerObject
);

Parameters

WdfDevice

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

Config

A pointer to the UCMTCPCI_PORT_CONTROLLER_CONFIG that is initialized by calling UCMTCPCI_PORT_CONTROLLER_CONFIG_INIT. This value cannot be NULL.

Attributes

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

PortControllerObject

A pointer to a location that receives a handle to the new port controller object.

Return value

(NTSTATUS) The method returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method may return an appropriate NTSTATUS error code.

Return code Description
STATUS_INVALID_DEVICE_REQUEST
 The handle to a framework device object is invalid.
STATUS_INFO_LENGTH_MISMATCH
 Invalid size for the structure pointed to by Config or Config->Capabilities. Must be size of UCMTCPCI_PORT_CONTROLLER_CONFIG or UCMTCPCI_PORT_CONTROLLER_CAPABILITIES, respectively.

Requirements

Requirement Value
Minimum supported client Windows 10
Minimum supported server Windows Server 2016
Target Platform Windows
Header ucmtcpciportcontroller.h
Library Ucmtcpcicxstub.lib
IRQL PASSIVE_LEVEL

See also

EVT_WDF_DRIVER_DEVICE_ADD

UCMTCPCI_PORT_CONTROLLER_CONFIG

WdfDeviceCreate