Cicode Programming Reference > Cicode Function Categories > Page Functions > PageKeyboardCommandsPut

PageKeyboardCommandsPut

Allows you to assign keyboard commands to an object or group. A keyboard command is a particular key sequence which executes a command when it is typed in by the operator at runtime.

Syntax

HRESULT PageKeyboardCommandsPut(nINdex, bstrKeySequence, bstrCommand, nArea, nPrivilege, bstrLogging)

nIndex:

Position of the keyboard command (as you can define more than one).

bstrKeySequence

Key sequences that the operator can enter to execute a command.

bstrCommand

The commands (set of instructions) to be executed immediately when the selected key sequence is entered. The commands can be a maximum of 253 characters long.

nArea

Use this to assign the keyboard command to the same area as the object/group.

nPrivilege

Use this to assign the keyboard command the same privilege as the object/group.

bstrLogging

Enables sending a log message to the Log Device.

Return Value

HRESULT - Indicates success or failure. 0 indicates success.

 

Published June 2018