IASForm::get_WaitStatus

This method gets the status of the wait cursor.

Syntax

HRESULT get_WaitStatus( BOOL *pfWaitStatus );

Parameters

pfWaitStatus

Pointer to a Boolean that indicates the status of the wait cursor. TRUE indicates that the wait cursor is set. FALSE indicates that the wait cursor is not set.

Return Values

NOERROR indicates success. If an error occurs, the appropriate HRESULT value is returned.

Remarks

The hour glass or wait cursor shows that a process is taking place, such as copying a file. To ensure that an application does not interrupt the process, check the status of the wait cursor. When the wait cursor is set, a wait icon is displayed in the center of the form.

See Also

IASForm::put_WaitStatus