SIS - Application Programmatic Interface, Reference Manual - ICS ...

SIS-Application Programmatic Interface, Reference Manual
Appendix A – C-API function declaration
Here follows a list of the type definitions of data types seen in the argument list of
some functions of the SIS C application programmatic interface (C-API):
typedef char l _name[LOGINAM_SIZE];
typedef char name_buffer[INPUT_LOGINAM_SIZE];
struct category_set {
name_buffer fcl;
name_buffer cat;
int direction; /* FORWARD, BACKWARD, BOTH_DIR */
};
typedef struct category_set categories_set[NUMBER_OF_CATEGORIES];
typedef struct cm_value {
int type; /* TYPE_INT, TYPE_STRING, TYPE_FLOAT,
TYPE_NODE, TYPE_EMPTY, TYPE_TIME */
int sysid;
union {
TIME t;
char *s;
int n;
float r;
}value;
}cm_value;
typedef struct cm_value cm_value;
Here follows a list of functions to set the cm_value fields.
char *cm_to_str(cm_value *val);
void print_val(cm_value *cmv);
int assign_node(cm_value *cmv, char *s, int sysid);
int assign_string(cm_value *cmv, char *s);
void assign_time(cm_value *cmv, TIME t);
void assign_int(cm_value *cmv, int n);
void assign_float(cm_value *cmv, float r);
void assign_empty(cm_value *cmv);
ATTENTION !!! Since the system dynamically allocates space to return string
information to a cm_value structure, this space should be freed when not needed
(see section 6.8.2) on memory management.
In the following pagesof the appendix we present the complete listing of the definition
of the functions the API consists of.
August 2002/v2.2.2 -43- ICS-FORTH