Remote Desktop Services API Functions
The following functions are used with Remote Desktop Services.
In this section
-
Retrieves the Remote Desktop Services session associated with a specified process.
-
Opens a handle to the specified Remote Desktop license server.
-
Closes an open handle to a Remote Desktop license server.
-
Returns the certificate of the Remote Desktop license server.
-
Begins enumeration through all key packs that are installed on a Remote Desktop license server based on search criteria.
-
Continues from a previous call to the TLSKeyPackEnumBegin function and terminates the enumeration.
-
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.
-
Begins enumeration of licenses that are issued by the Remote Desktop license server based on search criteria.
-
Continues from a previous call to the TLSLicenseEnumBegin function and terminates the enumeration.
-
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.
-
Closes the client end of a virtual channel.
-
An application-defined entry point for the client-side DLL of an application that uses Remote Desktop Services virtual channels.
-
Initializes a client DLL's access to Remote Desktop Services virtual channels.
-
An application-defined callback function that Remote Desktop Services calls to notify the client DLL of virtual channel events.
-
Opens the client end of a virtual channel.
-
An application-defined callback function that Remote Desktop Services calls to notify the client DLL of events for a specific virtual channel.
-
Sends data from the client end of a virtual channel to a partner application on the server end.
-
Closes an open handle to a Remote Desktop Session Host (RD Session Host) server.
-
Connects a Remote Desktop Services session to an existing session on the local computer.
-
Creates a new Remote Desktop Services listener or configures an existing listener.
-
Disconnects the logged-on user from the specified Remote Desktop Services session without closing the session.
-
Enables or disables Child Sessions.
-
Enumerates all the Remote Desktop Services listeners on a RD Session Host server.
-
Retrieves information about the active processes on a specified RD Session Host server.
-
Retrieves information about the active processes on the specified RD Session Host server or Remote Desktop Virtualization Host (RD Virtualization Host) server.
-
Returns a list of all RD Session Host servers within the specified domain.
-
Retrieves a list of sessions on a RD Session Host server.
-
Retrieves a list of sessions on a specified RD Session Host server or RD Virtualization Host server.
-
Frees memory allocated by a Remote Desktop Services function.
-
Frees memory that contains WTS_PROCESS_INFO_EX or WTS_SESSION_INFO_1 structures allocated by a Remote Desktop Services function.
-
Retrieves the session identifier of the console session.
-
Retrieves the child session identifier, if present.
-
Retrieves the security descriptor of a Remote Desktop Services listener.
-
Determines whether child sessions are enabled.
-
Logs off a specified Remote Desktop Services session.
-
Opens a handle to the specified RD Session Host server.
-
Opens a handle to the specified RD Session Host server or RD Virtualization Host server.
-
Retrieves configuration information for a Remote Desktop Services listener.
-
Retrieves session information for the specified session on the specified RD Session Host server.
-
Retrieves configuration information for the specified user on the specified domain controller or RD Session Host server.
-
Obtains the primary access token of the logged-on user specified by the session ID.
-
Registers the specified window to receive session change notifications.
-
Registers the specified window to receive session change notifications.
-
Displays a message box on the client desktop of a specified Remote Desktop Services session.
-
Configures the security descriptor of a Remote Desktop Services listener.
-
Modifies configuration information for the specified user on the specified domain controller or RD Session Host server.
-
Shuts down (and optionally restarts) the specified RD Session Host server.
-
Starts the remote control of another Remote Desktop Services session. You must call this function from a remote session.
-
Stops a remote control session.
-
Terminates the specified process on the specified RD Session Host server.
-
Unregisters the specified window so that it receives no further session change notifications.
-
Unregisters the specified window so that it receives no further session change notifications.
-
Closes an open virtual channel handle.
-
Opens a handle to the server end of a specified virtual channel.
-
Creates a virtual channel in a manner similar to WTSVirtualChannelOpen.
-
Deletes all queued input data sent from the client to the server on a specified virtual channel.
-
Deletes all queued output data sent from the server to the client on a specified virtual channel.
-
Returns information about a specified virtual channel.
-
Reads data from the server end of a virtual channel.
-
Writes data to the server end of a virtual channel.
-
Waits for a Remote Desktop Services event before returning to the caller.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for