NDIS_SWITCH_PORT_PROPERTY_CUSTOM structure (ntddndis.h)

Article
02/22/2024

The NDIS_SWITCH_PORT_PROPERTY_CUSTOM structure specifies a custom policy property for a Hyper-V extensible switch port.

Independent software vendors (ISVs) define the format for the custom properties. The format of the custom property is proprietary to the ISV.

Syntax

typedef struct _NDIS_SWITCH_PORT_PROPERTY_CUSTOM {
  NDIS_OBJECT_HEADER Header;
  ULONG              Flags;
  ULONG              PropertyBufferLength;
  ULONG              PropertyBufferOffset;
} NDIS_SWITCH_PORT_PROPERTY_CUSTOM, *PNDIS_SWITCH_PORT_PROPERTY_CUSTOM;

Members

Header

The type, revision, and size of the NDIS_SWITCH_PORT_PROPERTY_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_PROPERTY_CUSTOM structure, the Revision member of Header must be set to the following value:

NDIS_SWITCH_PORT_PROPERTY_CUSTOM_REVISION_1

Original version for NDIS 6.30 and later.

Set the Size member to NDIS_SIZEOF_NDIS_SWITCH_PORT_PROPERTY_CUSTOM_REVISION_1.

Flags

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

PropertyBufferLength

A ULONG value that specifies the size, in bytes, of the buffer that contains the custom port property.

PropertyBufferOffset

A ULONG value that specifies the offset, in bytes, to the property buffer. The offset is measured from the start of the NDIS_SWITCH_PORT_PROPERTY_CUSTOM structure up to the beginning of the property buffer.

Remarks

The NDIS_SWITCH_PORT_PROPERTY_CUSTOM structure is used in the following OID set requests:

The NDIS_SWITCH_PORT_PROPERTY_CUSTOM structure follows the NDIS_SWITCH_PORT_PROPERTY_PARAMETERS structure in the buffer that is associated with these OID set requests. The InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to this buffer.

Extensible switch extensions can access the custom port property buffer inside an NDIS_SWITCH_PORT_PROPERTY_CUSTOM structure by using the NDIS_SWITCH_PORT_PROPERTY_CUSTOM_GET_BUFFER macro.

For more information about extensible switch policies, see Hyper-V Extensible Switch Policies.

Requirements

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