GetWinInfo Method (CLIENT)

PLB Web Only, 9.7C

The GetWinInfo method retrieves basic metadata about the client UI. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A CLIENT object.

return

Optional. A Character String Variable that receives the browser window position and size data in delimited fields.

options

Optional. A Numeric Variable or decimal number that specifies data fields to be returned.

delim

Optional. A Character String Variable or string literal defining the character that delimits the fields within the returned string.

Flags Affected: OVER, ZERO

Note the following:

1. The EOS flag is set if the returned field data string must be truncated before being stored into the {return} Character variable.

2. The ZERO flag is always cleared.

3. The OVER flag is always cleared.

4. This method returns the browser window position and size data as a string of ASCII fields separated using a delimiter character.

5. The default delimiter character is the 0x7F character. The DELIMITER keyword changes this character.

6. The following positition and size fields are expected for a browser window as follows based on the {option} bit mask value. If the {option} parameter is not specified the default action is to return all fields described as follows:

 

Option	Returns
0x0	all fields.
0x1	the inner height of a window's content area.
0x2	the inner width of a window's content area.
0x4	the outer height of a window including toolbars andscrollbars.
0x8	the outer width of a window including toolbars and scrollbars.
0x10	the pixels the current document has been scrolled (horizontally) from the upper left corner of the window.
0x20	the pixels the current document has been scrolled (vertically) from the upper left corner of the window.
0x40	the horizontal coordinate of the window relative to the screen.
0x80	the vertical coordinate of the window relative to the screen.

Example:

Client CLIENT

         Client.GetWinInfo Giving FullData Using 0,","

This example returns all data files using a comma delimiter character.

See Also: CLIENT, Client Methods, Method Syntax