The LoRS API for ExNodes

Function Documentation

void lorsGetLibraryVersion (  const char **    package, const double *    version )

Returns package name and decimal number representing the library version. the package name and library version will be returned in the approiate variables. Either or both may be null, in which case, nothing useful will be done. Parameters: package  A pointer to a char *, in which the package name will be returned. version  A pointer to a double precision version number. Returns: void

int lorsExnodeEnum (  LorsExnode *    exnode, LorsEnum *    list )

Form an enumeration of all mappings within the Exnode. In order to enumerate through all of the mapping within a LorsExnode, you may use lorsExnodeEnum(). It returns a LorsEnum which can then be passed to lorsEnumNext() to get each successive mapping. Parameters: exnode  A LorsExnode list  A pointer to a LorsEnum

int lorsExnodeCreate (  LorsExnode **    exnode )

Allocate a container structure for LorsSets. The LorsExnode acts as a container structure for all user created LorsSets. Parameters: exnode  A pointer to a LorsExnode pointer into which the allocated structure will be returned. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsAppendSet (  LorsExnode *    exnode, LorsSet *    set )

Append a Set to an Exnode. To append a Set to the exnode container structure, a previously created Set is given as parameters. Parameters: exnode  The LorsExnode created from a successful call to lorsExnodeCreate() set  A previously created LorsSet to be added to exnode. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsAppendMapping (  LorsExnode *    exnode, LorsMapping *    map )

Add mapping to exnode. Add an existing mapping to an exnode. This is useful for creating a new exnode from an old exnode in combination with lorsExnodeEnum() Parameters: exnode  The LorsExnode to add the mapping. map  The LorsMapping to add to the exnode. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsDetachMapping (  LorsExnode *    exnode, LorsMapping *    map )

Remove mapping from exnode. Remove a mapping from an Exnode. This is useful for modifying the content of an exnode when used in combination with lorsExnodeEnum() Parameters: exnode  The LorsExnode to add the mapping. map  The LorsMapping to add to the exnode. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsDeserialize (  LorsExnode **    exnode, char *    buffer, int    length, char *    schema )

Reconstruct the Exnode datastructure from an XML serialization. After a lorsSerialize() call, you will have an XML string representative of the Exnode data structure. To recover the data structure from the XML serialization, you must deserialize it. Parameters: exnode  A pointer to a pointer, in which the new structure is returned. buffer  A NULL terminated buffer with the serialized Exnode. length  The length of the buffer to deserialize. schema  An optional Schema file for DTD or Schema Validation. (unsupported) Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsFileDeserialize (  LorsExnode **    exnode, char *    filename, char *    schema )

Deserialize from File rather than from buffer. After a lorsFileSerialize() call, you will ahve an XML file representative of the Exnode data structure. To recover the data structure from the XML serialization, you must deserialize it. Parameters: exnode  A pointer to a pointer, in which the new structure is returned. filename  The name of a Serialized Exnode. schema  An optional Schema file for DTD or Schema Validation. (unsupported) Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsSerialize (  LorsExnode *    exnode, char **    buffer, int    readonly, int *    length )

Translate Exnode structure to XML string. To preserve the structure of the Exnode across invocations of an application, the lorsSerialize() call translates the Exnode structure to an ASCII encoding. Parameters: exnode  The Exnode structure to serialize. buffer  The location into which a pointer to the resulting serialization will be placed. readonly  Whether or not to include Write and Manage Capabilities in the XML serialization. length  The final length of buffer. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsFileSerialize (  LorsExnode *    exnode, char *    filename, int    readonly, int    opts )

Serialize Exnode and store to file. To preserve the structure of the Exnode across invocations of an application, the lorsFileSerialize() call trans lates the Exnode structure to an ASCII text File. Parameters: exnode  filename  Name of file to create or overwrite with new serialization. readonly  Whether or not to include Write and Manage Capabilities in the XML serialization. opts  In what way to serialize the thing. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsQuery (  LorsExnode *    exnode, LorsSet **    set, longlong    offset, longlong    length, int    opt )

Find a set within an exnode which conforms to specified search criteria. Parameters: exnode  A LorsExnode pointer previouly created from lorsFileDeserialize() or lorsExnodeCreate() set  The pointer into which the matching set will be returned. offset  Mappings from offset. length  To offset + length opt  Other options to add to the Query. LORS_QUERY_REMOVE Returns: There are various error conditions. See list of