WTSOpenServerA function

Opens a handle to the specified Remote Desktop Session Host (RD Session Host) server.

Syntax

HANDLE WTSOpenServerA(
  LPSTR pServerName
);

Parameters

pServerName

Pointer to a null-terminated string specifying the NetBIOS name of the RD Session Host server.

Return Value

If the function succeeds, the return value is a handle to the specified server.

If the function fails, it returns a handle that is not valid. You can test the validity of the handle by using it in another function call.

Remarks

When you have finished using the handle returned by WTSOpenServer, release it by calling the WTSCloseServer function.

You do not need to open a handle for operations performed on the RD Session Host server on which your application is running. Use the constant WTS_CURRENT_SERVER_HANDLE instead.

Requirements

   
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header wtsapi32.h
Library Wtsapi32.lib
DLL Wtsapi32.dll

See Also

WTSCloseServer