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

SIS- Application Programmatic Interface, Reference Manual
with both types. If a function requires only a logical name or only a system identifier
it is stated in the function description.
In order to execute updates on a database a transaction session must be initiated. A
transaction session can either be initiated directly or from within a query session.
When a transaction session is in progress a write lock is applied to the database and
only the writing client can access it. A transaction session begins with the
begin_transaction() function and ends with either the end_transaction() function
(commits changes) or with the abort_transaction() function (does not commit
changes). When the transaction session is initiated from within a query session, on
termination of the transaction session the query session continues, and thus a read
lock exists on the database. In order to release the read lock end the query session by
calling end_query().
The functions presented below return APIFail(-1) on error and APISucc(0) on
success.
6.7.1 Addition Operations
These operations are used to add objects to the database:
int Add_Node(int sessionID, IDENTIFIER *node_name, int level)
Adds a node with the logical name node_name at instantiation level level
(SIS_API_TOKEN_CLASS,SIS_API_S_CLASS,SIS_API_M1_CLASS,SIS_API_M
2_CLASS,SIS_API_M3_CLASS,SIS_API_M4_CLASS).
int Add_Named_Attribute(int sessionID, IDENTIFIER *attribute, IDENTIFIER
*from, cm_value *to, int iLevel, int catSet)
Adds a named attribute with the logical name attribute pointing from from
(IDENTIFIER contains the SYSID) to cm_value to at instantiation level
iLevel
(SIS_API_TOKEN_CLASS,SIS_API_S_CLASS,SIS_API_M1_CLASS,SIS_API_M
2_CLASS,SIS_API_M3_CLASS,SIS_API_M4_CLASS) with categories the
categories given in the set identifier catSet. If catSet is -1 then no categories
are used. The function fails if any of from or to does not exist, or any of iLevel
or catSet is invalid
int Add_Unnamed_Attribute(int sessionID, IDENTIFIER *from, cm_value *to, int
catSet)
Adds an unnamed attribute pointing from from to cm_value to with categories
the categories given in the set identified by catSet. If catSet is -1 then no
categories are used. The function fails if any of from or to does not exist, or
catSet is invalid.
int Add_Instance(int sessionID, IDENTIFIER *from, IDENTIFIER *to)
Adds an instance pointing from from to to. It fails if any of from or to does not
exist.
Add_Instance_Set(int sessionID, int from_set, to IDENTIFIER *to)
August 2002/v2.2.2 -38- ICS-FORTH