WCOLS()

Class

Screen Windows

Purpose

Function to return the number of columns in a window

Syntax

WCOLS([<window-name>])

See Also

ACTIVATE WINDOW, DEACTIVATE WINDOW, DEFINE WINDOW, HIDE WINDOW, MOVE WINDOW, WEXIST(), WONTOP(), WOUTPUT(), WROWS(), WVISIBLE()

Description

The WCOLS() function returns the number of columns in a window. A window is an area of the screen designated for output and input. There is no limit to the number of defined windows. Windows are created with the DEFINE WINDOW command, and are activated with the ACTIVATE WINDOW command. With no parameter, the WCOLS() function operates on the active window. If no windows are active, the WCOLS() function returns a zero.

If a <window-name> is specified, the WCOLS() function returns the number of columns in that window. If the window specified does not exist, or is not active, the WCOLS() function returns a zero.

Example

define window browse;
  from 2,2 to 12,43;
  title "BROWSE Window";
  color n/bg;
  float;
  shadow
activate window browse
?wcols("browse")
        40

Products

Recital Mirage Server, Recital Terminal Developer