GetLogEventName method of the Win32_TSGatewayServerSettings class

Returns the log event name for the specified log event index.

Syntax

uint32 GetLogEventName(
  [in]  uint32 EventIndex,
  [out] string EventName
);

Parameters

EventIndex [in]

Index of the log event. The value must be between zero and the value of the MaxLogEvents property.

EventName [out]

Name of the specified event. The following list displays the possible values.

LogChannelDisconnect

User successfully disconnected from the resource.

LogFailureChannelConnect

User failed to connect to the resource.

LogFailureConnectionAuthorizationCheck

User failed connection authorization.

LogFailureResourceAuthorizationCheck

User failed resource authorization.

LogSuccessfulChannelConnect

User successfully connected to the resource.

LogSuccessfulConnectionAuthorizationCheck

User successfully passed connection authorization.

LogSuccessfulResourceAuthorizationCheck

User successfully passed resource authorization.

Return value

If the method succeeds, it returns zero. If the method is unsuccessful, it returns a nonzero value. For a list of error codes, see Remote Desktop Services WMI Provider Error Codes.

Remarks

You must be a member of the Administrators group to call this method.

Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Microsoft Windows Software Development Kit (SDK). They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).

Requirements

Requirement Value
Minimum supported client
None supported
Minimum supported server
Windows Server 2008
Namespace
Root\CIMv2\TerminalServices
MOF
TSGateway.mof
DLL
AagWmi.dll

See also

Win32_TSGatewayServerSettings

EnableLogEvent

IsLogEventEnabled