Export (0) Print
Expand All

ManagementTaskAttribute Class

The ManagementTask attribute indicates that the target method implements a WMI method.

System::Object
  System::Attribute
    System.Management.Instrumentation::ManagementMemberAttribute
      System.Management.Instrumentation::ManagementTaskAttribute

Namespace:  System.Management.Instrumentation
Assembly:  System.Core (in System.Core.dll)

[AttributeUsageAttribute(AttributeTargets::Method, AllowMultiple = false)]
[HostProtectionAttribute(SecurityAction::LinkDemand, MayLeakOnAbort = true)]
public ref class ManagementTaskAttribute sealed : public ManagementMemberAttribute

The ManagementTaskAttribute type exposes the following members.

  NameDescription
Public methodManagementTaskAttributeInitializes a new instance of the ManagementTaskAttribute class. This is the default constructor.
Top

  NameDescription
Public propertyNameGets or sets the name of the management attribute. (Inherited from ManagementMemberAttribute.)
Public propertySchemaGets or sets a value that defines the type of output that the method that is marked with the ManagementTask attribute will output.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute::GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute::GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute::GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute::InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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.

[C#]

// 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();

}

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft