SCCommandFlag

Communications commands have dynamic or run-time status, consisting of the bit-flags enumerated by SCCommandFlag. Zero or more bit-flags can apply to a given command at any given time.

Note: In developing a driver, specify the names of the status flags, such as SC_CF_DISABLED, SC_CF_BLINKING, and so on, rather than the integer values.

enum SCCommandFlag
{
    SC_CF_NOTSUPPORTED  = 1,
    SC_CF_DISABLED      = 2,
    SC_CF_CHECKED       = 4,
    SC_CF_BLINKING      = 8,
    SC_CF_NOPARAMSOK    = 16,
    SC_CF_STRPARAMSOK   = 32
};

Each bit-flag that can be associated with a command is described as follows:

• SC_CF_NOTSUPPORTED. The command is not supported.

• SC_CF_DISABLED. The command is supported, but is disabled at this time.

• SC_CF_CHECKED. The command is in a checked state; for example, when an agent is in Not Ready mode, the command to set the Not Ready state is checked. This flag can be used to specify a toggle state for commands in the communications toolbar or in the Communications submenu of the Tools application-level menu.

• SC_CF_BLINKING. Blinking is enabled for communications toolbar buttons, such as those for the Accept Work Item and Resume Work Item commands.

• SC_CF_NOPARAMSOK. The command does not require any parameters to execute. For example, the commands for releasing a call and for toggling the Not Ready state do not require parameters.

• SC_CF_STRPARAMSOK. The command can be executed by providing a single unnamed string parameter (no named parameter is provided). The command for placing a call, for example, requires only a single parameter. Such commands are invoked when the user types something in the input field in the communications toolbar, such as an extension number, and clicks the command’s button.

Note: If a device command’s status excludes SC_CF_NOTSUPPORTED or SC_CF_DISABLED bit flags, then the command is considered enabled.