Export (0) Print
Expand All
Expand Minimize

WTSOpenServer function

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

Syntax


HANDLE WTSOpenServer(
  _In_  LPTSTR pServerName
);

Parameters

pServerName [in]

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.

Windows Server 2003:  If the function fails, the return value is NULL. To get extended error information, call GetLastError.

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 2003

Header

Wtsapi32.h

Library

Wtsapi32.lib

DLL

Wtsapi32.dll

Unicode and ANSI names

WTSOpenServerW (Unicode) and WTSOpenServerA (ANSI)

See also

WTSCloseServer

 

 

Show:
© 2014 Microsoft