Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  IDL Reference  >  Operating System Access  >  IDLsysMonitorInfo::GetRectangles

IDLsysMonitorInfo::GetRectangles

IDLsysMonitorInfo::GetRectangles

Syntax | Return Value | Arguments | Keywords | Version History

The IDLsysMonitorInfo::GetRectangles function method retrieves the monitor coordinate rectangles.

Syntax


Result = Obj->[IDLsysMonitorInfo::]GetRectangles( [, /EXCLUDE_TASKBAR])

Return Value


Returns the monitors’ coordinate rectangles. A coordinate rectangle refers to a 4-element array of the form [x,y,w,h], where x and y are the origin at the upper-left corner of the rectangle and where w and h are the width and height of the rectangle.

There is one row returned in the array for each monitor, each column in the array contains a value for a component of each monitor (see Table 10-3 for the array columns).

Array Column

Content

First Column

Contains the x coordinate of the upper-left pixel of the monitor

Second Column

Contains the y coordinate of the upper-left pixel

Third Column

Contains the monitor width (w) in pixels

Fourth Column

Contains the monitor height (h) in pixels

If no monitors are available on the system, or if the DISPLAY_NAME property does not refer to a valid X server connection, IDLsysMonitorInfo::GetRectangles returns a four-element IDL long array containing zero values.

Arguments


None

Keywords


EXCLUDE_TASKBAR

Set this keyword to cause the returned monitor rectangle information to not include the region of the monitor occupied by the Windows task bar. This keyword is supported on the Windows platform only and is ignored on all other platforms.

Version History


6.3

Introduced



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us