NDIS_CONFIGURATION_PARAMETER structure

The NDIS_CONFIGURATION_PARAMETER structure contains the data and type of a named entry in the registry.

Syntax


typedef struct _NDIS_CONFIGURATION_PARAMETER {
  NDIS_PARAMETER_TYPE ParameterType;
  union {
    ULONG       IntegerData;
    NDIS_STRING StringData;
    BINARY_DATA BinaryData;
  } ParameterData;
} NDIS_CONFIGURATION_PARAMETER, *PNDIS_CONFIGURATION_PARAMETER;

Members

ParameterType

The type of the parameter specified as one of the NDIS_PARAMETER_TYPE enumeration values.

For successful calls to the NdisReadConfiguration function, the ParameterType value matches the value at the ParameterType parameter. However, when the ParameterType parameter is NdisParameterHexInteger, the resulting ParameterType member value is NdisParameterInteger.

ParameterData

A union that contains the value of the given named entry. If ParameterType is a string type, this member is an NDIS_STRING type describing a counted string in the system-default character set. For Microsoft Windows 2000 and later drivers, such a string contains Unicode characters. That is, for Windows 2000 and later, NDIS defines the NDIS_STRING type as a UNICODE_STRING type.

This union contains the following members:

IntegerData

A ULONG value that is used when the ParameterType member is set to NdisParameterInteger or NdisParameterHexInteger.

StringData

An NDIS_STRING value that is used when the ParameterType member is set to NdisParameterString or NdisParameterMultiString.

BinaryData

A BINARY_DATA structure that is used when the ParameterType member is set to NdisParameterBinary.

Remarks

To read parameters in the registry, an NDIS driver can call the NdisReadConfiguration function. If the call is successful, NDIS returns a pointer to an NDIS_CONFIGURATION_PARAMETER structure at the ParameterValue parameter of NdisReadConfiguration.

To write parameters to the registry, an NDIS driver can call the NdisWriteConfiguration function. In this case, the driver initializes an NDIS_CONFIGURATION_PARAMETER structure and passes it at the ParameterValue parameter of NdisWriteConfiguration.

Requirements

Version

Supported for NDIS 6.0 and NDIS 5.1 drivers in Windows Vista. Supported for NDIS 5.1 drivers in Windows XP.

Header

Ndis.h (include Ndis.h)

See also

BINARY_DATA
NDIS_PARAMETER_TYPE
NdisReadConfiguration
NdisWriteConfiguration
UNICODE_STRING

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft