ST_STATUS

ST_STATUS — contains return values for some Cogent C API functions.

Synopsis

typedef enum
{
    ST_OK = 0, ST_ERROR, ST_NO_TASK, ST_NO_MSG, ST_WOULDBLOCK, ST_INTR,
    ST_FULL, ST_LOCKED, ST_SECURITY, ST_NO_POINT, ST_INSIG, ST_UNKNOWN,
    ST_NO_QUEUE, ST_CMD_SYNTAX_ERROR, ST_REPLIED, ST_WRONG_TYPE,
    ST_TOO_LARGE, ST_NO_MEMORY, ST_OLD_DATA, ST_TIMEOUT
} ST_STATUS;

Members

The following descriptions are general, and should be interpreted in the context of the specific function and circumstances.

ST_OKThe function executed without error.
ST_ERRORAn error occurred.
ST_NO_TASKA required task does not exist.
ST_NO_MSGThere is no message available.
ST_WOULDBLOCKThis action would block, and is not permitted.
ST_INTRAn interrupt occurred.
ST_FULLThe queue is full.
ST_LOCKEDA Cascade DataHub point is locked.
ST_SECURITYThe security level is insufficient.
ST_NO_POINTA required Cascade DataHub point does not exist.
ST_INSIGA change in a Cascade DataHub point's value is insignificant. This is not really an error, but a notification that no exception will be generated by the datahub.
ST_UNKNOWNThere is an unknown error.
ST_NO_QUEUEA target task has no queue, or qserve is absent.
ST_CMD_SYNTAX_ERRORThe command was not found, or there was a syntax error.
ST_REPLIEDThe reply was complete.
ST_WRONG_TYPEThe type of a point or variable was wrong.
ST_TOO_LARGEA value to be written to memory is larger than the available buffer.
ST_NO_MEMORYThere is insufficient memory available.
ST_OLD_DATATime-significant data is out of date.
ST_TIMEOUTA timeout occurred in poll mode.

Description

This structure contains return values for some Cogent C API functions.