waitCursor::CheckEsc

CheckEsc

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 header to Include

Description

The CheckEsc method allows a program to capture user hitting ESC to abort the current operation

Syntax

BOOL CheckEsc( )

Parameters

Return

TRUE if user has hit the ESC key, FALSE otherwise

Examples

EX1

void waitCursor_waitCursor_ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(wks==NULL)
        return;
    
    waitCursor    cur;
    string    str;
    int        nCol = 0;
    for(int ii = 0; ii < 10000 && !cur.CheckEsc();ii++)
    {
        wks.AddCol();
        str.Format("Adding col %d", nCol++);
        SetDataDisplayText(str);
    }
    if(ii < 10000)
        printf("User abort adding columns, only %d columns are added\n", nCol);
    
}