OID_SWITCH_PORT_PROPERTY_ENUM

The Hyper-V extensible switch extension issues an object identifier (OID) method request of OID_SWITCH_PORT_PROPERTY_ENUM to obtain an array. This array contains the provisioned port policies that match the specified criteria. Each element in the array specifies the properties of a policy for a specified extensible switch port.

The InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to a buffer. This buffer contains the following data:

Remarks

Before it issues an OID method request of OID_SWITCH_PORT_PROPERTY_ENUM, the extensible switch extension must follow these guidelines:

  • The extension can only issue the OID_SWITCH_PORT_PROPERTY_ENUM request after the protocol edge of the extensible switch issues an OID_SWITCH_PORT_CREATE request and before it issues an OID_SWITCH_PORT_TEARDOWN request.

  • The extension must call ReferenceSwitchPort before it calls NdisFOidRequest to issue the OID_SWITCH_PORT_PROPERTY_ENUM request. This ensures that the specified port will not be deleted until after the OID request is completed.

    After the OID request is completed, the extension must call DereferenceSwitchPort. The extension must call this function regardless of whether the OID request was completed with NDIS_STATUS_SUCCESS.

The OID_SWITCH_PORT_PROPERTY_ENUM OID must only be issued when the Hyper-V extensible switch has completed activation. Please see Querying the Hyper-V Extensible Switch Configuration for more details.

Note  If the extension receives the OID method request of OID_SWITCH_PORT_PROPERTY_ENUM, it must not complete the OID request. Instead, it must call NdisFOidRequest to forward the OID request down the extensible switch driver stack.

Return Status Codes

The underlying miniport edge of the extensible switch completes the OID query request of OID_SWITCH_PORT_PROPERTY_ENUM and returns the following status code.

Status Code Description

NDIS_STATUS_SUCCESS

The OID request completed successfully.

Requirements

Version

Supported in NDIS 6.30 and later.

Header

Ntddndis.h (include Ndis.h)

See also


DereferenceSwitchPort

NDIS_OID_REQUEST

NDIS_SWITCH_PORT_PROPERTY_ENUM_INFO

NDIS_SWITCH_PORT_PROPERTY_ENUM_PARAMETERS

NdisFOidRequest

Querying the Hyper-V Extensible Switch Configuration

ReferenceSwitchPort