TerminalServicesHelperWTSQuerySessionInformation Method

[DllImportAttribute("wtsapi32.dll")]
public static bool WTSQuerySessionInformation(
	IntPtr serverHandle,
	uint sessionId,
	WtsInfoType infoType,
	out IntPtr bufferPointer,
	out uint bytesReturned
)

<DllImportAttribute("wtsapi32.dll">]
Public Shared Function WTSQuerySessionInformation ( 
	serverHandle As IntPtr,
	sessionId As UInteger,
	infoType As WtsInfoType,
	<OutAttribute> ByRef bufferPointer As IntPtr,
	<OutAttribute> ByRef bytesReturned As UInteger
) As Boolean

public:
[DllImportAttribute(L"wtsapi32.dll")]
static bool WTSQuerySessionInformation(
	IntPtr serverHandle, 
	unsigned int sessionId, 
	WtsInfoType infoType, 
	[OutAttribute] IntPtr% bufferPointer, 
	[OutAttribute] unsigned int% bytesReturned
)

[<DllImportAttribute("wtsapi32.dll")>]
static member WTSQuerySessionInformation : 
        serverHandle : IntPtr * 
        sessionId : uint32 * 
        infoType : WtsInfoType * 
        bufferPointer : IntPtr byref * 
        bytesReturned : uint32 byref -> bool 

Parameters

serverHandle  IntPtr

A handle to an RD Session Host server. Specify a handle opened by the WTSOpenServer function, or specify WTS_CURRENT_SERVER_HANDLE to indicate the RD Session Host server on which your application is running.

sessionId  UInt32

A Remote Desktop Services session identifier. To indicate the session in which the calling application is running (or the current session) specify WTS_CURRENT_SESSION. Only specify WTS_CURRENT_SESSION when obtaining session information on the local server. If WTS_CURRENT_SESSION is specified when querying session information on a remote server, the returned session information will be inconsistent. Do not use the returned data. You can use the function to retrieve the identifiers of all sessions on a specified RD Session Host server.

infoType  WtsInfoType

A value of the enumeration that indicates the type of session information to retrieve in a call to the WTSQuerySessionInformation function.

bufferPointer  IntPtr

A pointer to a variable that receives a pointer to the requested information. The format and contents of the data depend on the information class specified in the infoType parameter. To free the returned buffer, call the function.

bytesReturned  UInt32

A pointer to a variable that receives the size, in bytes, of the data returned in bufferPointer.

Return Value

Reference