WLCOL( ) Function

Returns the column coordinate of the upper-left corner of the active or specified window.

WLCOL([WindowName])

Return Values

Numeric

Parameters

  • WindowName
    Specifies the window for which WLCOL( ) returns the column coordinate. In Visual FoxPro, you can also specify the name of a toolbar. If you omit WindowName, WLCOLS( ) returns the column coordinate of the active output window. You can also use the empty string for WindowName to specify the main Visual FoxPro window.

    In Visual FoxPro, if no window is active, WLCOLS( ) returns the column coordinate of the main Visual FoxPro window relative to the Windows desktop.

    If a system window (the Command window, the Data Session window, a Browse window, and so on) has been opened and is visible or hidden (its name appears on the Window menu), you can include its name in WLCOL( ). If you specify the name of a system window that is closed, Visual FoxPro generates an error message. The Debug window is an exception. Once the Debug window has been opened, its name can be included in WLCOL( ) if it is visible, hidden, or closed.

Remarks

The value returned by WLCOL( ) depends on the current video display mode, and is relative to the main Visual FoxPro window. The display mode can be changed with SET DISPLAY.

Windows can be positioned outside the main Visual FoxPro window. If the specified window is to the left of the main Visual FoxPro window, WCOL( ) returns a negative value. If the window's left border is to the right of the main Visual FoxPro window, WCOL( ) returns a positive value greater than the width of the main Visual FoxPro window.

See Also

SET DISPLAY | WCOLS( ) | WLROW( ) | WROWS( )