4 out of 10 rated this helpful - Rate this topic

WTSGetActiveConsoleSessionId function

Applies to: desktop apps only

Retrieves the Remote Desktop Services session that is currently attached to the physical console. The physical console is the monitor, keyboard, and mouse. Note that it is not necessary that Remote Desktop Services be running for this function to succeed.

Syntax

Copy

DWORD WTSGetActiveConsoleSessionId(void);

Parameters

This function has no parameters.

Return value

The session identifier of the session that is attached to the physical console. If there is no session attached to the physical console, (for example, if the physical console session is in the process of being attached or detached), this function returns 0xFFFFFFFF.

Remarks

The session identifier returned by this function is the identifier of the current physical console session. To monitor the state of the current physical console session, use the WTSRegisterSessionNotification function.

Requirements