MSFT_NetAdapterAdvancedPropertySettingData class

Article
05/31/2018

This class represents the advanced properties of a network adapter stored in the registry.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("NetAdapterCim")]
class MSFT_NetAdapterAdvancedPropertySettingData : MSFT_NetAdapterSettingData
{
  string  Caption;
  string  Description;
  string  ElementName;
  string  InstanceID;
  string  Name;
  string  InterfaceDescription;
  uint32  Source;
  string  SystemName;
  string  DisplayName;
  string  DisplayValue;
  string  DefaultDisplayValue;
  uint32  DisplayParameterType;
  boolean Optional;
  string  ValidRegistryValues[];
  string  ValidDisplayValues[];
  string  NumericParameterBaseValue;
  string  NumericParameterMinValue;
  string  NumericParameterMaxValue;
  string  NumericParameterStepValue;
  string  RegistryKeyword;
  uint32  RegistryDataType;
  string  RegistryValue[];
  string  DefaultRegistryValue;
};

Members

The MSFT_NetAdapterAdvancedPropertySettingData class has these types of members:

Methods
Properties

Methods

The MSFT_NetAdapterAdvancedPropertySettingData class has these methods.

Method	Description
Reset	Resets the advanced property of a network adapter to its factory default value.

Properties

The MSFT_NetAdapterAdvancedPropertySettingData class has these properties.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 64 )

A short textual description of the object. This property inherits from CIM_ManagedElement.

DefaultDisplayValue

Data type: string
Access type: Read-only

The description for the default value of the parameter. This property is only valid if the parameter is displayed in user interface.

DefaultRegistryValue

Data type: string
Access type: Read-only

Default registry value for the parameter. This property is only valid if the parameter is displayed in user interface.

Description

Data type: string
Access type: Read-only

A textual description of the object. This property inherits from CIM_ManagedElement.

DisplayName

Data type: string
Access type: Read-only

The property description in user interface. This property is only valid if the parameter is displayed in user interface.

DisplayParameterType

Data type: uint32
Access type: Read-only

This property specifies the type of the parameter. The "int", "long", "word", and "dword" types specify a numeric parameter; "edit" and "enum" types specify a text parameter. Note that the values for all the parameters that are displayed in the user interface, including numeric parameters, are stored in the registry as REG_SZ (null-terminated string) data type. This property is only valid if the parameter is displayed in user interface.

int (1)
long (2)
word (3)
dword (4)
enum (5)
edit (6)

DisplayValue

Data type: string
Access type: Read/write

The description for the current value of the property. This property is only valid if the parameter is displayed in user interface.

ElementName

Data type: string
Access type: Read-only

A user-friendly name for the object. This property enables each instance to define a display name in addition to its key properties, identity data, and description information. Be aware that the Name property of ManagedSystemElement is also defined as a display name. However, it is often subclassed to be a Key. The same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. This property inherits from CIM_ManagedElement.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above preferred algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM.

This property inherits from CIM_SettingData.

InterfaceDescription

Data type: string
Access type: Read-only

Interface Description, also known as "ifDesc" or display name is a unique name assigned to the network adapter during installation. This name cannot be changed and is persisted as long as the network adapter is not uninstalled. This property inherits from MSFT_NetAdapterSettingData.

Name

Data type: string
Access type: Read-only

Name, also known as Connection Name, "ifAlias", or InterfaceAlias, is a unique name assigned to the adapter during installation. The Name of the adapter can be changed by the administrator and is persisted across the boot or network adapter restart. This property inherits from MSFT_NetAdapterSettingData.

NumericParameterBaseValue

Data type: string
Access type: Read-only

The "Base" used in representing a numeric parameter. This property is only valid if the parameter is displayed in user interface.

NumericParameterMaxValue

Data type: string
Access type: Read-only

The maximum value of a numeric parameter. This property is only valid if the parameter is displayed in user interface.

NumericParameterMinValue

Data type: string
Access type: Read-only

The minimum value of a numeric parameter. This property is only valid if the parameter is displayed in user interface.

NumericParameterStepValue

Data type: string
Access type: Read-only

The "Step" value of a numeric parameter. This property is only valid if the parameter is displayed in user interface.

Optional

Data type: boolean
Access type: Read-only

If True, specifying this parameter is optional. Otherwise it is mandatory. This property is only valid if the parameter is displayed in user interface.

RegistryDataType

Data type: uint32
Access type: Read/write

Registry keyword data type. For parameters displayed in user interface, this value is always REG_SZ even if the parameter is a numeric parameter.

REG_SZ (1)
REG_DWORD (4)
REG_MULTI_SZ (7)
REG_QWORD (11)

RegistryKeyword

Data type: string
Access type: Read/write

Registry keyword name of the parameter. Registry keywords may be associated with a parameter displayed in user interface. Some registry keywords are not associated to any parameter displayed in user interface.

RegistryValue

Data type: string array
Access type: Read/write

Current value of the registry keyword. For a parameter that is displayed in user interface and is of "enum" type, this is a value in EnumParameterRegistryValues array and not the description for the current value of the parameter.

Source

Data type: uint32
Access type: Read-only

The source of the setting data. This property inherits from MSFT_NetAdapterSettingData.

Unknown (0)
Other (1)
Device (2)
Persistent storage (3)

SystemName

Data type: string
Access type: Read-only

The scoping System\'s Name. This property inherits from MSFT_NetAdapterSettingData.

ValidDisplayValues

Data type: string array
Access type: Read-only

An array of strings representing the descriptions for the registry keyword values used in EnumParameterRegistryValues. This property is only valid if the parameter is displayed in user interface.

ValidRegistryValues

Data type: string array
Access type: Read-only

An array of integers specifying the registry keyword values used to represent a parameter of the "enum" type. This property is only valid if the parameter is displayed in user interface.

Requirements


Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Root\StandardCimv2
MOF	NetAdapterCim.mof
DLL	NetAdapterCim.dll