OID_SWITCH_PARAMETERS

A Hyper-V extensible switch extension issues an object identifier (OID) query request of OID_SWITCH_PARAMETERS to obtain the configuration data of the extensible switch.

If the OID query request completes successfully, the InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to an NDIS_SWITCH_PARAMETERS structure.

Remarks

When the extension processes the returned NDIS_SWITCH_PARAMETERS structure, it must not assume that the various string members of the NDIS_SWITCH_PARAMETERS structure, such as SwitchName, are null-terminated. The data types for these string members are type-defined by the IF_COUNTED_STRING structure. The extension must determine the string length from the value of the Length member of this structure.

Note  If the string is null-terminated, the Length member must not include the terminating null character.

Return Status Codes

The underlying miniport edge of the extensible switch completes the OID query request of OID_SWITCH_PARAMETERS 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 OID_SWITCH_PARAMETERS structure for an OID query request. The underlying miniport edge of the extensible switch sets the DATA.QUERY_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_OID_REQUEST

NDIS_SWITCH_PARAMETERS

NdisFOidRequest