MSFT_MTEventProvider class
Encapsulates the properties of Windows event provider. Can also be used to enumerate all the event providers in the computer.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[UMLPackagePath("CIM::Core::CoreElements"), dynamic, provider("mttmprov"), AMENDMENT]
class MSFT_MTEventProvider : CIM_ManagedElement
{
string InstanceID;
string Caption;
string Description;
string ElementName;
string Name;
string DisplayName;
string DisplayPath;
uint32 ExportedChannelsCount;
};
Members
The MSFT_MTEventProvider class has these types of members:
Methods
The MSFT_MTEventProvider class has these methods.
| Method | Description |
|---|---|
| GetChannels | Gets all the event channels that are exported by the given event provider. If no ProviderName is specified, then gets all the classic event channels. |
| GetProvidersAndWindowsEventChannels | Gets the list of those event providers that export at least one event channel. Also gets the list of those event channels that are connected to Windows event logs. |
Properties
The MSFT_MTEventProvider class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The Caption property is a short textual description (one- line string) of the object.
This property is inherited from CIM_ManagedElement.
-
-
Description
-
-
Data type: string
-
Access type: Read-only
The Description property provides a textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
DisplayName
-
-
Data type: string
-
Access type: Read-only
The localized display name of the Windows event provider. If it is not indicated in the provider's manifest or not present in the provider's resource file, then it is set equal to the Name of the provider.
-
-
DisplayPath
-
-
Data type: string
-
Access type: Read-only
The localized display path of the Windows event provider. This display path is similar to what Windows Event Viewer uses to create hierarchical tree nodes for identification of event providers.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
Gets a user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of CIM_ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that 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 CIM_LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.
This property is inherited from CIM_ManagedElement.
-
-
ExportedChannelsCount
-
-
Data type: uint32
-
Access type: Read-only
The number of event channels exported by the event provider.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below. 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 <Schema Name>_<Class Name> 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 not null and 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. If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to "CIM".
This property is inherited from CIM_ManagedElement.
-
-
Name
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: key
The unique and language neutral identifier of the Windows event provider.
-
Requirements
| Minimum supported client |
Windows 10 [desktop apps only] |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\Microsoft\Windows\ManagementTools |
| MOF |
|
| DLL |
|