IOvStdio::IsKeyPressed

Check if the key is pressed.

HRESULT IsKeyPressed(

[in] VARIANT varKeyCodes,
[out, retval] VARIANT_BOOL* pbPressed
);

Parameters

varKeyCodes

Key codes that are scanned. For possible values, see the description of the property CancelKeys.

Returning Parameter

pbPressed

If one of the keys in varKeyCodes was pressed, VARIANT_TRUE is returned on this parameter. Otherwise, VARIANT_FALSE is returned.

HRESULT Return Values

S_OK

One of the keys in varKeyCodes was pressed.

S_FALSE

None of the keys in varKeyCodes key was pressed.

(FAILED)

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

Description

The IsKeyPressed method returns VARIANT_TRUE when any key specified with the parameter varKeyCodes is pressed. See the description of the property CancelKeys for possible values of the parameter varKeyCodes.