ManagementTaskAttribute 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 ManagementTask attribute indicates that the target method implements a WMI method.

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 ManagementTaskAttribute sealed : System::Management::Instrumentation::ManagementMemberAttribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)]
public sealed class ManagementTaskAttribute : System.Management.Instrumentation.ManagementMemberAttribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)>]
type ManagementTaskAttribute = class
    inherit ManagementMemberAttribute

Public NotInheritable Class ManagementTaskAttribute
Inherits ManagementMemberAttribute

Inheritance: Object

Attribute

ManagementMemberAttribute
ManagementTaskAttribute

Attributes: AttributeUsageAttribute

Examples

The following example shows how to mark a method with the ManagementTask attribute to expose the method to WMI. The method will show up in WMI as ResetCounters.

// Use the ManagementTask attribute to specify that a method
// is exposed to WMI through this provider. Consumers will be
// able to execute this method through WMI.
[ManagementTask]
public void ResetCounters()
{
    counter.Reset();
}

Remarks

By default, the WMI method name will be the name of the target method. The parent class of this attribute, ManagementMemberAttribute, includes a Name parameter. You can use that parameter to change the name of the method that is exposed through WMI without changing your internal method name.

The method must be public and it may be static. It can include any combination of [in], [out], [in/out], array or object reference parameters. Array parameters cannot be multidimensional or jagged because of limitations imposed by WMI.

The return type of the method can be: void, scalar, string, datetime or object. It cannot be an array.

Constructors

ManagementTaskAttribute()

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

Properties

Name	Gets or sets the name of the management attribute. (Inherited from ManagementMemberAttribute)
Schema	Gets or sets a value that defines the type of output that the method that is marked with the ManagementTask attribute will output.
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

Dela via