Remote Desktop Services API Functions

The following functions are used with Remote Desktop Services.

In this section

ProcessIdToSessionId: Retrieves the Remote Desktop Services session associated with a specified process.
TLSConnectToLsServer: Opens a handle to the specified Remote Desktop license server.
TLSDisconnectFromServer: Closes an open handle to a Remote Desktop license server.
TLSGetServerCertificate: Returns the certificate of the Remote Desktop license server.
TLSKeyPackEnumBegin: Begins enumeration through all key packs that are installed on a Remote Desktop license server based on search criteria.
TLSKeyPackEnumEnd: Continues from a previous call to the TLSKeyPackEnumBegin function and terminates the enumeration.
TLSKeyPackEnumNext: Continues from a previous call to the TLSKeyPackEnumBegin function and returns the next key pack that is installed on a Remote Desktop license server that matches the search criteria.
TLSLicenseEnumBegin: Begins enumeration of licenses that are issued by the Remote Desktop license server based on search criteria.
TLSLicenseEnumEnd: Continues from a previous call to the TLSLicenseEnumBegin function and terminates the enumeration.
TLSLicenseEnumNext: Continues from a previous call to the TLSLicenseEnumBegin function and returns the next license that is installed on a Remote Desktop license server that matches the search criteria.
VirtualChannelClose: Closes the client end of a virtual channel.
VirtualChannelEntry: An application-defined entry point for the client-side DLL of an application that uses Remote Desktop Services virtual channels.
VirtualChannelInit: Initializes a client DLL's access to Remote Desktop Services virtual channels.
VirtualChannelInitEvent: An application-defined callback function that Remote Desktop Services calls to notify the client DLL of virtual channel events.
VirtualChannelOpen: Opens the client end of a virtual channel.
VirtualChannelOpenEvent: An application-defined callback function that Remote Desktop Services calls to notify the client DLL of events for a specific virtual channel.
VirtualChannelWrite: Sends data from the client end of a virtual channel to a partner application on the server end.
WTSCloseServer: Closes an open handle to a Remote Desktop Session Host (RD Session Host) server.
WTSConnectSession: Connects a Remote Desktop Services session to an existing session on the local computer.
WTSCreateListener: Creates a new Remote Desktop Services listener or configures an existing listener.
WTSDisconnectSession: Disconnects the logged-on user from the specified Remote Desktop Services session without closing the session.
WTSEnableChildSessions: Enables or disables Child Sessions.
WTSEnumerateListeners: Enumerates all the Remote Desktop Services listeners on a RD Session Host server.
WTSEnumerateProcesses: Retrieves information about the active processes on a specified RD Session Host server.
WTSEnumerateProcessesEx: Retrieves information about the active processes on the specified RD Session Host server or Remote Desktop Virtualization Host (RD Virtualization Host) server.
WTSEnumerateServers: Returns a list of all RD Session Host servers within the specified domain.
WTSEnumerateSessions: Retrieves a list of sessions on a RD Session Host server.
WTSEnumerateSessionsEx: Retrieves a list of sessions on a specified RD Session Host server or RD Virtualization Host server.
WTSFreeMemory: Frees memory allocated by a Remote Desktop Services function.
WTSFreeMemoryEx: Frees memory that contains WTS_PROCESS_INFO_EX or WTS_SESSION_INFO_1 structures allocated by a Remote Desktop Services function.
WTSGetActiveConsoleSessionId: Retrieves the session identifier of the console session.
WTSGetChildSessionId: Retrieves the child session identifier, if present.
WTSGetListenerSecurity: Retrieves the security descriptor of a Remote Desktop Services listener.
WTSIsChildSessionsEnabled: Determines whether child sessions are enabled.
WTSLogoffSession: Logs off a specified Remote Desktop Services session.
WTSOpenServer: Opens a handle to the specified RD Session Host server.
WTSOpenServerEx: Opens a handle to the specified RD Session Host server or RD Virtualization Host server.
WTSQueryListenerConfig: Retrieves configuration information for a Remote Desktop Services listener.
WTSQuerySessionInformation: Retrieves session information for the specified session on the specified RD Session Host server.
WTSQueryUserConfig: Retrieves configuration information for the specified user on the specified domain controller or RD Session Host server.
WTSQueryUserToken: Obtains the primary access token of the logged-on user specified by the session ID.
WTSRegisterSessionNotification: Registers the specified window to receive session change notifications.
WTSRegisterSessionNotificationEx: Registers the specified window to receive session change notifications.
WTSSendMessage: Displays a message box on the client desktop of a specified Remote Desktop Services session.
WTSSetListenerSecurity: Configures the security descriptor of a Remote Desktop Services listener.
WTSSetUserConfig: Modifies configuration information for the specified user on the specified domain controller or RD Session Host server.
WTSShutdownSystem: Shuts down (and optionally restarts) the specified RD Session Host server.
WTSStartRemoteControlSession: Starts the remote control of another Remote Desktop Services session. You must call this function from a remote session.
WTSStopRemoteControlSession: Stops a remote control session.
WTSTerminateProcess: Terminates the specified process on the specified RD Session Host server.
WTSUnRegisterSessionNotification: Unregisters the specified window so that it receives no further session change notifications.
WTSUnRegisterSessionNotificationEx: Unregisters the specified window so that it receives no further session change notifications.
WTSVirtualChannelClose: Closes an open virtual channel handle.
WTSVirtualChannelOpen: Opens a handle to the server end of a specified virtual channel.
WTSVirtualChannelOpenEx: Creates a virtual channel in a manner similar to WTSVirtualChannelOpen.
WTSVirtualChannelPurgeInput: Deletes all queued input data sent from the client to the server on a specified virtual channel.
WTSVirtualChannelPurgeOutput: Deletes all queued output data sent from the server to the client on a specified virtual channel.
WTSVirtualChannelQuery: Returns information about a specified virtual channel.
WTSVirtualChannelRead: Reads data from the server end of a virtual channel.
WTSVirtualChannelWrite: Writes data to the server end of a virtual channel.
WTSWaitSystemEvent: Waits for a Remote Desktop Services event before returning to the caller.