IOvStdio::IsCancelKeyPressed

Check if one of keys specified with the property CancelKeys is pressed.

HRESULT IsCancelKeyPressed([out, retval] VARIANT_BOOL* pbPressed);

Parameters

None.

Returning Parameter

pbPressed

If the Cancel key was pressed, VARIANT_TRUE is returned on this parameter. Otherwise, VARIANT_FALSE is returned.

HRESULT Return Values

S_OK

Cancel key was pressed.

S_FALSE

Cancel key was not pressed.

(FAILED)

An error occurred. IErrorInfo was created. A detailed error description is traced.

Description

The IsCancelKeyPressed method returns VARIANT_TRUE when any key specified with the property CancelKeys is pressed.