Skip to content

WTSQuerySessionInformation.md

Latest commit

 

History

History
70 lines (47 loc) · 1.6 KB

WTSQuerySessionInformation.md

File metadata and controls

70 lines (47 loc) · 1.6 KB

Home

Function name : WTSQuerySessionInformation

Group: Terminal Services - Library: wtsapi32

Retrieves session information for the specified session on the specified terminal server. It can be used to query session information on local and remote terminal servers.

Declaration:

BOOL WTSQuerySessionInformation(
	HANDLE hServer,
	DWORD SessionId,
	WTS_INFO_CLASS WTSInfoClass,
	LPTSTR* ppBuffer,
	DWORD* pBytesReturned
);

FoxPro declaration:

DECLARE INTEGER WTSQuerySessionInformationA IN Wtsapi32;
AS WTSQuerySessionInformation;
	INTEGER hServer,;
	LONG SessionId,;
	INTEGER WTSInfoClass,;
	INTEGER @ppBuffer,;
	LONG @pBytesReturned

Parameters:

hServer [in] Handle to a terminal server.

SessionId [in] A Terminal Services session identifier.

WTSInfoClass [in] Specifies the type of information to retrieve.

ppBuffer [out] Pointer to a variable that receives a pointer to the requested information.

pBytesReturned [out] Pointer to a variable that receives the size, in bytes, of the data returned in ppBuffer.

Return value:

If the function succeeds, the return value is a nonzero value.

Comments:

For hServer, specify a handle opened by the WTSOpenServer function, or specify WTS_CURRENT_SERVER_HANDLE to indicate the terminal server on which your application is running.

To free the returned buffer, call the WTSFreeMemory function.