Difference between revisions of "WCOLS()"

From Recital Documentation Wiki
Jump to: navigation, search
(Products)
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
==Class==
 
Screen Windows
 
 
 
 
==Purpose==
 
==Purpose==
 
Function to return the number of columns in a window
 
Function to return the number of columns in a window
Line 35: Line 31:
  
 
==Products==
 
==Products==
Recital Mirage Server, Recital Terminal Developer
+
Recital  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Screen Windows]]
 
[[Category:Screen Windows]]
 
[[Category:Screen Windows Functions]]
 
[[Category:Screen Windows Functions]]

Latest revision as of 16:58, 8 December 2009

Purpose

Function to return the number of columns in a window


Syntax

WCOLS([<window-name>])


See Also

ACTIVATE SCREEN, ACTIVATE WINDOW, CLEAR WINDOWS, DEACTIVATE WINDOW, DEFINE WINDOW, HIDE WINDOW, MOVE WINDOW, RELEASE WINDOWS, RESIZE WINDOW, RESTORE WINDOW, SAVE WINDOW, SHOW WINDOW, WEXIST(), WONTOP(), WOUTPUT(), WROWS(), WTITLE(), 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