ssCore.SysInfo.getWindowList

Get a list of open application windows both hidden and visible.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

format - [Optional] - Specifies the format of the returned data. If no format is specified, TEXT is assumed Valid values include: TEXT and XML.

showHidden - [Optional] - A flag that determines whether hidden windows will be displayed or not. If this parameter is omitted, hidden windows will not be shown in the list. Valid values include: true and false. Default value is false.

showProcessId - [Optional] - A flag that determines whether the id of the process that owns the window should be displayed or not. Valid values include: true and false. Default value is false.


Output Parameters:

result - A list of open windows. In the default TEXT format, each row in the returned window list consists of four (or five) items the window handle, the window status (visible or hidden), the window caption, the window class name and optionally - the id of the process that owns the window. The items in each row are separated by tabs and the rows are separated by carriage return '\r' characters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.SysInfo.getWindowList( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.SysInfo.getWindowList( paramsObject );


Notes:

None.


Examples:

var return_obj = ssCore.SysInfo.getWindowList({showHidden:false});

ssDebug.trace(return_obj.result);