OID_SWITCH_PROPERTY_ENUM
The Hyper-V extensible switch extension issues an object identifier (OID) method request of OID_SWITCH_PROPERTY_ENUM to obtain an array. This array contains the provisioned switch policies that match the specified criteria. Each element in the array specifies the properties of an extensible switch policy.
The InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to a buffer. This buffer contains the following data:
An NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS structure that specifies the parameters for the extensible switch policy enumeration.
An array of NDIS_SWITCH_PROPERTY_ENUM_INFO structures. Each of these structures contains information about an extensible switch policy.
Note If the extension has not been provisioned with instances of the specified extensible switch policy, the extension sets the NumProperties member of the NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS structure to zero and no NDIS_SWITCH_PROPERTY_ENUM_INFO structures are returned.
Remarks
The OID_SWITCH_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.
Unlike OID query requests of OID_SWITCH_PORT_PROPERTY_ENUM, the extension does not have to call any ReferenceSwitchXxx or DereferenceSwitchXxx functions when it issues the OID_SWITCH_PROPERTY_ENUM request down the extensible switch driver stack.
Note If the extension receives the OID method request of OID_SWITCH_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_PROPERTY_ENUM and returns one of the following status codes.
Status Code | Description |
---|---|
NDIS_STATUS_SUCCESS |
The OID request completed successfully. |
NDIS_STATUS_INVALID_LENGTH |
The length of the information buffer is too small to return the NDIS_SWITCH_PROPERTY_ENUM_PARAMETERS structure and its array of NDIS_SWITCH_PROPERTY_ENUM_INFO elements. The underlying miniport edge of the extensible switch sets the DATA.METHOD_INFORMATION.BytesNeeded member in the NDIS_OID_REQUEST structure to the minimum buffer size that is required. |
NDIS_STATUS_FAILURE |
The request failed for other reasons. |
Requirements
Version |
Supported in NDIS 6.30 and later. |
Header |
Ntddndis.h (include Ndis.h) |
See also
NDIS_SWITCH_PROPERTY_ENUM_INFO