MSFT_MTEventChannel class

Encapsulates the properties of the Windows event channel. Can also be used to perform operations related to the particular event channel.

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_MTEventChannel : CIM_ManagedElement
{
  string  InstanceID;
  string  Caption;
  string  Description;
  string  ElementName;
  string  Name;
  string  DisplayName;
  string  DisplayPath;
  string  LogFilePath;
  boolean Enabled;
  boolean ClassicLog;
  uint32  Type;
  uint64  LogFileSize;
  string  EventsCount;
};

Members

The MSFT_MTEventChannel class has these types of members:

• Methods
• Properties

Methods

The MSFT_MTEventChannel class has these methods.

Method	Description
ClearLogFile	Clears the log file associated with the event channel.
Disable	Disables the logging associated with the event channel.
Enable	Enables the logging associated with the event channel.
GetEventRecords	Retrieves the details of events generated in an event log by a particular source.
GetWindowsEventChannels	Gets the list of those event channels that are connected to Windows event logs.

Properties

The MSFT_MTEventChannel 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.

ClassicLog

Data type: boolean

Access type: Read-only

Flag that indicates whether the event channel is a classic event channel.

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 event channel.

DisplayPath

Data type: string

Access type: Read-only

The localized display path of the event channel. The value of this property may or may not be different from the DisplayName.

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.

Enabled

Data type: boolean

Access type: Read-only

Flag that indicates whether the event channel is enabled.

EventsCount

Data type: string

Access type: Read-only

The total number of events in the log file that backs the event channel.

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.

LogFilePath

Data type: string

Access type: Read-only

The path to the file that backs the event channel.

LogFileSize

Data type: uint64

Access type: Read-only

The size of the file, in bytes, of the log file that backs the event channel.

Name

Data type: string

Access type: Read-only

Qualifiers: key

The unique and language neutral identifier of the event channel.

Type

Data type: uint32

Access type: Read-only

The type of a channel.

Admin (0)

Operational (1)

Analytic (2)

Debug (3)

Requirements

Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016
Namespace	Root\Microsoft\Windows\ManagementTools
MOF	MtTmProv.mof
DLL	MtTmProv.dll

See also

CIM_ManagedElement