NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM structure (ntddndis.h)

Article
05/26/2021

The NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM structure specifies the custom status information for a Hyper-V extensible switch port. This information is known as feature status information. The format of this information is defined by the independent software vendor (ISV).

Syntax

typedef struct _NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM {
  NDIS_OBJECT_HEADER Header;
  ULONG              Flags;
  ULONG              FeatureStatusBufferLength;
  ULONG              FeatureStatusBufferOffset;
} NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM, *PNDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM;

Members

Header

The type, revision, and size of the NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM structure. This member is formatted as an NDIS_OBJECT_HEADER structure.

The Type member of Header must be set to NDIS_OBJECT_TYPE_DEFAULT. To specify the version of the NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM structure, the Revision member of Header must be set to the following value:

NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM_REVISION_1

Original version for NDIS 6.30 and later.

Set the Size member to NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM_REVISION_1.

Flags

A ULONG value that contains a bitwise OR of flags. This member is reserved for NDIS.

FeatureStatusBufferLength

A ULONG value that specifies the size, in bytes, of the feature status buffer.

FeatureStatusBufferOffset

A ULONG value that specifies the offset, in bytes, to the feature status buffer that follows the NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM structure. The offset is measured from the start of the NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM structure up to the beginning of the feature status buffer.

Remarks

The NDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS structure is used in OID method requests of OID_SWITCH_PORT_FEATURE_STATUS_QUERY. This OID request returns the following structures in the information buffer that is associated with the OID request:

An NDIS_SWITCH_PORT_FEATURE_STATUS_PARAMETERS structure that specifies the parameters for the feature status information that is to be returned for an extensible switch port. The switch extension populates the FeatureStatusVersion member of the structure to reflect the version of the custom status being returned in the NDIS_SWITCH_FEATURE_STATUS_CUSTOM buffer. The Hyper-v Extensible switch populates all other members when issuing the query OID.
An NDIS_SWITCH_PORT_FEATURE_STATUS_CUSTOM structure that contains the feature status data for the specified extensible switch port. The switch extension populates the FeatureStatusCustomBufferLength member of the structure to reflect the size of the custom status being returned. The Hyper-v Extensible switch populates all other members when issuing the query OID.

The InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to this information buffer.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.30 and later.
Header	ntddndis.h (include Ndis.h)