4.5 WFS_CMD_SIU_SET_AUXILIARY

Description This command is used to set the status of an Auxiliary indicator.

Input Param LPWFSSIUSETAUXILIARY lpSetAuxiliary;

typedef struct _wfs_siu_set_auxiliary
{
WORD wAuxiliary;
WORD fwCommand;
} WFSSIUSETAUXILIARY, * LPWFSSIUSETAUXILIARY;

wAuxiliary
Specifies the index of the Auxiliary indicator to set as one of the following values:

Value Meaning

WFS_SIU_VOLUME Set the value of the volume control.

WFS_SIU_UPS Set the value of the UPS.

fwCommand
It specifies the values for the volume control or the command to the UPS device. Specified as one of the following values:

Value Meaning

1, ..., 1000 The volume level. This field is handled as an unsigned short. If a value greater than 1000 is used, the provider will map the value to 1000.

WFS_SIU_ENGAGE Engage the UPS.

WFS_SIU_DISENGAGE Disengage the UPS.

See WFS_CMD_SIU_SET_PORTS command for a detailed description.

Output Param None.

Error Codes The following additional error codes can be generated by this command:

Value Meaning

WFS_ERR_SIU_INVALID_PORT An attempt to set a port to a new value was invalid because the port does not exist or the port is pre-configured as an input port.

WFS_ERR_SIU_SYNTAX The command was invoked with incorrect input data.

WFS_ERR_SIU_PORT_ERROR A hardware error occurred while executing the command.

Events The following additional events can be generated by this command:

Value Meaning

WFS_EXEE_SIU_PORT_ERROR An error occurred while attempting to set the status of the auxiliary indicator.

Comments None.