Package com.sun.jna.platform.win32
Interface Wtsapi32
-
- All Superinterfaces:
AltCallingConvention,Library,StdCall,StdCallLibrary
public interface Wtsapi32 extends StdCallLibrary
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classWtsapi32.WTS_CLIENT_ADDRESSContains the client network address of a Remote Desktop Services session.static interfaceWtsapi32.WTS_CONNECTSTATE_CLASSSpecifies the connection state of a Remote Desktop Services session.static interfaceWtsapi32.WTS_INFO_CLASSContains values that indicate the type of session information to retrieve in a call to theWTSQuerySessionInformation(com.sun.jna.platform.win32.WinNT.HANDLE, int, int, com.sun.jna.ptr.PointerByReference, com.sun.jna.ptr.IntByReference)function.static classWtsapi32.WTS_PROCESS_INFO_EXContains extended information about a process running on a Remote Desktop Session Host (RD Session Host) server.static classWtsapi32.WTS_SESSION_INFOContains information about a client session on a Remote Desktop Session Host (RD Session Host) server.static classWtsapi32.WTSINFOContains information about a Remote Desktop Services session.-
Nested classes/interfaces inherited from interface com.sun.jna.Library
Library.Handler
-
Nested classes/interfaces inherited from interface com.sun.jna.win32.StdCallLibrary
StdCallLibrary.StdCallCallback
-
-
Field Summary
Fields Modifier and Type Field Description static intDOMAIN_LENGTHDefined inwinsta.hand present in this interface to properly size theWtsapi32.WTSINFOstructure.static Wtsapi32INSTANCEstatic intNOTIFY_FOR_ALL_SESSIONSstatic intNOTIFY_FOR_THIS_SESSIONstatic intUSERNAME_LENGTHDefined inwinsta.hand present in this interface to properly size theWtsapi32.WTSINFOstructure.static intWINSTATIONNAME_LENGTHDefined inwinsta.hand present in this interface to properly size theWtsapi32.WTSINFOstructure.static intWTS_ANY_SESSIONSpecifies any-session (SessionId)static intWTS_CONSOLE_CONNECTThe session identified by lParam was connected to the console terminal or RemoteFX session.static intWTS_CONSOLE_DISCONNECTThe session identified by lParam was disconnected from the console terminal or RemoteFX session.static WinNT.HANDLEWTS_CURRENT_SERVER_HANDLESpecifies the current serverstatic intWTS_CURRENT_SESSIONSpecifies the current session (SessionId)static intWTS_PROCESS_INFO_LEVEL_0static intWTS_PROCESS_INFO_LEVEL_1static intWTS_REMOTE_CONNECTThe session identified by lParam was connected to the remote terminal.static intWTS_REMOTE_DISCONNECTThe session identified by lParam was disconnected from the remote terminal.static intWTS_SESSION_LOCKThe session identified by lParam has been locked.static intWTS_SESSION_LOGOFFA user has logged off the session identified by lParam.static intWTS_SESSION_LOGONA user has logged on to the session identified by lParam.static intWTS_SESSION_REMOTE_CONTROLThe session identified by lParam has changed its remote controlled status.static intWTS_SESSION_UNLOCKThe session identified by lParam has been unlocked.-
Fields inherited from interface com.sun.jna.Library
OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER
-
Fields inherited from interface com.sun.jna.win32.StdCallLibrary
FUNCTION_MAPPER, STDCALL_CONVENTION
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanWTSEnumerateProcessesEx(WinNT.HANDLE hServer, IntByReference pLevel, int SessionID, PointerByReference ppProcessInfo, IntByReference pCount)Retrieves information about the active processes on the specified Remote Desktop Session Host (RD Session Host) server or Remote Desktop Virtualization Host (RD Virtualization Host) server.booleanWTSEnumerateSessions(WinNT.HANDLE hServer, int Reserved, int Version, PointerByReference ppSessionInfo, IntByReference pCount)Retrieves a list of sessions on a Remote Desktop Session Host (RD Session Host) server.voidWTSFreeMemory(Pointer pMemory)Frees memory allocated by a Remote Desktop Services function.booleanWTSFreeMemoryEx(int WTSTypeClass, Pointer pMemory, int NumberOfEntries)Frees memory that contains WTS_PROCESS_INFO_EX or WTS_SESSION_INFO_1 structures allocated by a Remote Desktop Services function.booleanWTSQuerySessionInformation(WinNT.HANDLE hServer, int SessionId, int WTSInfoClass, PointerByReference ppBuffer, IntByReference pBytesReturned)Retrieves session information for the specified session on the specified Remote Desktop Session Host (RD Session Host) server.booleanWTSRegisterSessionNotification(WinDef.HWND hWnd, int dwFlags)Registers the specified window to receive session change notifications.booleanWTSUnRegisterSessionNotification(WinDef.HWND hWnd)Unregisters the specified window so that it receives no further session change notifications.
-
-
-
Field Detail
-
INSTANCE
static final Wtsapi32 INSTANCE
-
NOTIFY_FOR_ALL_SESSIONS
static final int NOTIFY_FOR_ALL_SESSIONS
- See Also:
- Constant Field Values
-
NOTIFY_FOR_THIS_SESSION
static final int NOTIFY_FOR_THIS_SESSION
- See Also:
- Constant Field Values
-
WTS_CONSOLE_CONNECT
static final int WTS_CONSOLE_CONNECT
The session identified by lParam was connected to the console terminal or RemoteFX session.- See Also:
- Constant Field Values
-
WTS_CONSOLE_DISCONNECT
static final int WTS_CONSOLE_DISCONNECT
The session identified by lParam was disconnected from the console terminal or RemoteFX session.- See Also:
- Constant Field Values
-
WTS_REMOTE_CONNECT
static final int WTS_REMOTE_CONNECT
The session identified by lParam was connected to the remote terminal.- See Also:
- Constant Field Values
-
WTS_REMOTE_DISCONNECT
static final int WTS_REMOTE_DISCONNECT
The session identified by lParam was disconnected from the remote terminal.- See Also:
- Constant Field Values
-
WTS_SESSION_LOGON
static final int WTS_SESSION_LOGON
A user has logged on to the session identified by lParam.- See Also:
- Constant Field Values
-
WTS_SESSION_LOGOFF
static final int WTS_SESSION_LOGOFF
A user has logged off the session identified by lParam.- See Also:
- Constant Field Values
-
WTS_SESSION_LOCK
static final int WTS_SESSION_LOCK
The session identified by lParam has been locked.- See Also:
- Constant Field Values
-
WTS_SESSION_UNLOCK
static final int WTS_SESSION_UNLOCK
The session identified by lParam has been unlocked.- See Also:
- Constant Field Values
-
WTS_SESSION_REMOTE_CONTROL
static final int WTS_SESSION_REMOTE_CONTROL
The session identified by lParam has changed its remote controlled status. To determine the status, call GetSystemMetrics and check the SM_REMOTECONTROL metric.- See Also:
- Constant Field Values
-
WTS_CURRENT_SERVER_HANDLE
static final WinNT.HANDLE WTS_CURRENT_SERVER_HANDLE
Specifies the current server
-
WTS_CURRENT_SESSION
static final int WTS_CURRENT_SESSION
Specifies the current session (SessionId)- See Also:
- Constant Field Values
-
WTS_ANY_SESSION
static final int WTS_ANY_SESSION
Specifies any-session (SessionId)- See Also:
- Constant Field Values
-
WTS_PROCESS_INFO_LEVEL_0
static final int WTS_PROCESS_INFO_LEVEL_0
- See Also:
- Constant Field Values
-
WTS_PROCESS_INFO_LEVEL_1
static final int WTS_PROCESS_INFO_LEVEL_1
- See Also:
- Constant Field Values
-
DOMAIN_LENGTH
static final int DOMAIN_LENGTH
Defined inwinsta.hand present in this interface to properly size theWtsapi32.WTSINFOstructure.- See Also:
- Constant Field Values
-
USERNAME_LENGTH
static final int USERNAME_LENGTH
Defined inwinsta.hand present in this interface to properly size theWtsapi32.WTSINFOstructure.- See Also:
- Constant Field Values
-
WINSTATIONNAME_LENGTH
static final int WINSTATIONNAME_LENGTH
Defined inwinsta.hand present in this interface to properly size theWtsapi32.WTSINFOstructure.- See Also:
- Constant Field Values
-
-
Method Detail
-
WTSEnumerateSessions
boolean WTSEnumerateSessions(WinNT.HANDLE hServer, int Reserved, int Version, PointerByReference ppSessionInfo, IntByReference pCount)
Retrieves a list of sessions on a Remote Desktop Session Host (RD Session Host) server.- Parameters:
hServer- A handle to the RD Session Host server.You can use the
WTSOpenServerorWTSOpenServerExfunctions to retrieve a handle to a specific server, orWTS_CURRENT_SERVER_HANDLEto use the RD Session Host server that hosts your application.Reserved- This parameter is reserved. It must be zero.Version- The version of the enumeration request. This parameter must be 1.ppSessionInfo- A pointer to an array ofWtsapi32.WTS_SESSION_INFOstructures that represent the retrieved sessions. To free the returned buffer, call theWTSFreeMemory(com.sun.jna.Pointer)function.pCount- A pointer to the number ofWTS_SESSION_INFOstructures returned in theppSessionInfoparameter.- Returns:
- Returns
falseif this function fails. If this function succeeds, returnstrue.To get extended error information, call
Kernel32.GetLastError().
-
WTSQuerySessionInformation
boolean WTSQuerySessionInformation(WinNT.HANDLE hServer, int SessionId, int WTSInfoClass, PointerByReference ppBuffer, IntByReference pBytesReturned)
Retrieves session information for the specified session on the specified Remote Desktop Session Host (RD Session Host) server. It can be used to query session information on local and remote RD Session Host servers.- Parameters:
hServer- A handle to an RD Session Host server. Specify a handle opened by theWTSOpenServerfunction, or specifyWTS_CURRENT_SERVER_HANDLEto indicate the RD Session Host server on which your application is running.SessionId- A Remote Desktop Services session identifier. To indicate the session in which the calling application is running (or the current session) specifyWTS_CURRENT_SESSION. Only specifyWTS_CURRENT_SESSIONwhen obtaining session information on the local server. IfWTS_CURRENT_SESSIONis 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
WTSEnumerateSessionsExfunction to retrieve the identifiers of all sessions on a specified RD Session Host server.To query information for another user's session, you must have Query Information permission.
WTSInfoClass- A value of theWtsapi32.WTS_INFO_CLASSenumeration that indicates the type of session information to retrieve in a call to theWTSQuerySessionInformationfunction.ppBuffer- 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 theWTSInfoClassparameter. To free the returned buffer, call theWTSFreeMemory(com.sun.jna.Pointer)function.pBytesReturned- A pointer to a variable that receives the size, in bytes, of the data returned in ppBuffer.- Returns:
- If the function succeeds, returns
true.If the function fails, returns
false. To get extended error information, callKernel32.GetLastError().
-
WTSFreeMemory
void WTSFreeMemory(Pointer pMemory)
Frees memory allocated by a Remote Desktop Services function.- Parameters:
pMemory- Pointer to the memory to free.
-
WTSRegisterSessionNotification
boolean WTSRegisterSessionNotification(WinDef.HWND hWnd, int dwFlags)
Registers the specified window to receive session change notifications.- Parameters:
hWnd- [in] Handle of the window to receive session change notifications.dwFlags- [in] Specifies which session notifications are to be received. This parameter can be one of the following values.- Returns:
- If the function succeeds, the return value is TRUE. Otherwise, it is FALSE. To get extended error information, call GetLastError.
-
WTSUnRegisterSessionNotification
boolean WTSUnRegisterSessionNotification(WinDef.HWND hWnd)
Unregisters the specified window so that it receives no further session change notifications.- Parameters:
hWnd- [in] Handle of the window to be unregistered from receiving session notifications.- Returns:
- If the function succeeds, the return value is TRUE. Otherwise, it is FALSE. To get extended error information, call GetLastError.
-
WTSEnumerateProcessesEx
boolean WTSEnumerateProcessesEx(WinNT.HANDLE hServer, IntByReference pLevel, int SessionID, PointerByReference ppProcessInfo, IntByReference pCount)
Retrieves information about the active processes on the specified Remote Desktop Session Host (RD Session Host) server or Remote Desktop Virtualization Host (RD Virtualization Host) server.- Parameters:
hServer- 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 server on which your application is running.pLevel- A pointer to a DWORD variable that, on input, specifies the type of information to return. To return an array of WTS_PROCESS_INFO structures, specify zero. To return an array of WTS_PROCESS_INFO_EX structures, specify one. If you do not specify a valid value for this parameter, on output, WTSEnumerateProcessesEx sets this parameter to one and returns an error. Otherwise, on output, WTSEnumerateProcessesEx does not change the value of this parameter.SessionID- The session for which to enumerate processes. To enumerate processes for all sessions on the server, specify WTS_ANY_SESSION.ppProcessInfo- A pointer to a variable that receives a pointer to an array of WTS_PROCESS_INFO or WTS_PROCESS_INFO_EX structures. The type of structure is determined by the value passed to the pLevel parameter. Each structure in the array contains information about an active process. When you have finished using the array, free it by calling the WTSFreeMemoryEx function. You should also set the pointer to NULL.pCount- A pointer to a variable that receives the number of structures returned in the buffer referenced by the ppProcessInfo parameter.- Returns:
- If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. To get extended error information, call the GetLastError function.
-
WTSFreeMemoryEx
boolean WTSFreeMemoryEx(int WTSTypeClass, Pointer pMemory, int NumberOfEntries)Frees memory that contains WTS_PROCESS_INFO_EX or WTS_SESSION_INFO_1 structures allocated by a Remote Desktop Services function.- Parameters:
WTSTypeClass- A value of the WTS_TYPE_CLASS enumeration type that specifies the type of structures contained in the buffer referenced by the pMemory parameter.pMemory- A pointer to the buffer to free.NumberOfEntries- The number of elements in the buffer referenced by the pMemory parameter.- Returns:
- If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. To get extended error information, call the GetLastError function.
-
-