ManagementKeyAttribute Class

Reference

Definition

Namespace:: System.Management.Instrumentation

Assembly:: System.Core.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The ManagementKey attribute identifies the key properties of a WMI class.

Note: the WMI .NET libraries are now considered in final state, and no further development, enhancements, or updates will be available for non-security related issues affecting these libraries. The MI APIs should be used for all new development.

public ref class ManagementKeyAttribute sealed : System::Management::Instrumentation::ManagementMemberAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class ManagementKeyAttribute : System.Management.Instrumentation.ManagementMemberAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)>]
type ManagementKeyAttribute = class
    inherit ManagementMemberAttribute

Public NotInheritable Class ManagementKeyAttribute
Inherits ManagementMemberAttribute

Inheritance: Object

Attribute

ManagementMemberAttribute
ManagementKeyAttribute

Attributes: AttributeUsageAttribute

Examples

The following example shows how to use the ManagementKeyAttribute to mark a field as a key property of a WMI class.

[ManagementKey]
public int id;

The next example shows how to use the ManagementKeyAttribute attribute to mark a key property of a WMI class.

// Use the ManagementKey attribute to specify that this property
// is used as the key identifier of this class and for the WMI
// instances of this class.  This property must be unique for each
// class instance.
[ManagementKey]
public int Id
{
    get { return System.Diagnostics.Process.GetCurrentProcess().Id; }
}

Remarks

Unless a WMI class is a singleton, it can have multiple corresponding instances. Clients of the class must be able to uniquely identify the specific instance they are interested in. So, as a provider writer, you must choose a property or set of properties that uniquely identify an instance of each of your WMI classes. You use the ManagementKeyAttribute attribute to identify those key properties. Properties identified as keys have the same runtime behavior as read-only properties indicated by the ManagementProbeAttribute attribute.

Constructors

ManagementKeyAttribute()

Initializes a new instance of the ManagementKeyAttribute class. This is the parameterless constructor.

Properties

Name	Gets or sets the name of the management attribute. (Inherited from ManagementMemberAttribute)
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)

Applies to

Jaa