Share via

MCOL( ) Function

  • Article

Returns the column position of the mouse pointer in the main Visual FoxPro window or a user-defined window.

MCOL([cWindowName [, nScaleMode]])

Return Values

Numeric

Parameters

  • cWindowName
    Specifies the name of the window whose mouse-pointer column position MCOL( ) returns.

    If you omit cWindowName and there is no active user-defined window, MCOL( ) returns the mouse pointer's column position in the main Visual FoxPro window. If you omit cWindowName and there is an active user-defined window, MCOL( ) returns the mouse pointer's column position in the active user-defined window. MCOL( ) returns –1 if the mouse pointer is positioned outside the user-defined window or if no mouse driver is loaded and there is no output window.

  • nScaleMode
    Specifies the unit of measurement for the value MCOL( ) returns. The settings for nScaleMode are:

    nScaleMode Description
    0 (Default) Foxels. A foxel is equivalent to the average height and width of a character based on the current font of the form in which an object is contained. Foxels are useful in developing cross-platform applications for character-based and graphical platforms.
    3 Pixels. A pixel is the smallest element that can be displayed on a screen or printer. Pixels are screen-dependent.

See Also

AMOUSEOBJ( ) | COL( ) | GridHitTest Method | INKEY( ) | ISMOUSE( ) | MROW( ) | ROW( ) | WCOLS( ) | WROWS( )