Rocs API

XML: $Source: /home/cvs/xspooler/rocs/rocs.xml,v $
XML: $Revision: 1.85 $
Module: rocs
Auto generated at: Sun Jan 25 08:27:13 2009
Index: rocsapi-index.html

1. object Attr

DOM Attribute as used in Node.
Summary of object Attr
BooleangetBoolean( iOAttr inst );
Attribute value.
instAttribute instance.*
const char*getEscVal( iOAttr inst );
Escaped attribute value.
instAttribute instance.*
doublegetFloat( iOAttr inst );
Attribute value.
instAttribute instance.*
intgetInt( iOAttr inst );
Attribute value.
instAttribute instance.*
longgetLong( iOAttr inst );
Attribute value.
instAttribute instance.*
const char*getName( iOAttr inst );
Attribute name.
instAttribute instance.*
const char*getVal( iOAttr inst );
Attribute value.
instAttribute instance.*
iOAttrinst( const char* name, const char* val );
Creates an attribute with given name and value.
nameAttribute name.*
valAttribute value.*
iOAttrinstInt( const char* name, int val );
Creates an attribute with given name and integer value.
nameAttribute name.*
valAttribute value.*
voidsetBoolean( iOAttr inst, Boolean val );
Change attribute value.
instAttribute instance.*
valNew attribute value.*
voidsetFloat( iOAttr inst, double val );
Change attribute value.
instAttribute instance.*
valNew attribute value.*
voidsetInt( iOAttr inst, int val );
Change attribute value.
instAttribute instance.*
valNew attribute value.*
voidsetLong( iOAttr inst, long val );
Change attribute value.
instAttribute instance.*
valNew attribute value.*
voidsetName( iOAttr inst, const char* name );
Change attribute name.
instAttribute instance.*
nameNew attribute name.*
voidsetVal( iOAttr inst, const char* val );
Change attribute value.
instAttribute instance.*
valNew attribute value.*

2. object CmdLn

Commandline helper object.
Summary of object CmdLn
intgetIntDef( iOCmdLn inst, const char* key, int defval );
Get an integer value by key. Returns given default value if not found.
instCmdLn instance.*
keyArgument key.*
defvalDefault value.*
const char*getStr( iOCmdLn inst, const char* key );
Get a string value by key.
instCmdLn instance.*
keyArgument key.*
const char*getStrDef( iOCmdLn inst, const char* key, const char* defval );
Get a string value by key. Returns given default value if not found.
instCmdLn instance.*
keyArgument key.*
defvalDefault value.*
BooleanhasKey( iOCmdLn inst, const char* key );
Test if the given key was on the commandline.
instCmdLn instance.*
keyArgument key.*
iOCmdLninst( int argc, const char** argv );
Creates a commandline object.
argcArgument count.*
argvArgument values.*

3. object Dir

Directory helper object.
Summary of object Dir
typedefenum {SORT_NAME=0, SORT_OLDEST=1, SORT_NEWEST=2} sortmode
voidcleandirlist( iOList list );
free all memory allocated by listdir()
listDirectory list.*
voidclose( iODir inst );
Closes the direntry.
instDir instance.*
intgetRc( iODir inst );
Get the last error.
instDir instance.*
iODirinst( const char* path );
Creates a directory object.
pathPath pointing to the directory.*
iOListlistdir( const char* path, const char* ext, sortmode sort );
Scans the directory for entries with given ending.
pathDirectory to scan.*
extFile filter.*
Booleanopen( iODir inst );
Opens the directory for reading.
instDir instance.*
const char*read( iODir inst );
Reads an direntry.
instDir instance.*
intscandir( const char* path, const char* ext );
Scans the directory for entries with given ending.
pathDirectory to scan.*
extFile filter.*

4. object Doc

XML Document parser and builder.
Summary of object Doc
typedefenum {MaxNodeNameLen=1024,MaxAttrNameLen=1024,MaxAttrValLen=1024} parserConst
File type.
const const char*ENC_UTF8 = UTF-8
const const char*ENC_ISO885915 = ISO-8859-15
BooleangetBool( iODoc inst, const char* nodename, const char* attrname, Boolean defval );
Search for a given attribute in the given node.
instDoc instance.*
nodenameNode name.*
attrnameAttribute name.*
defvalDefault value if attribute or node is not found in the document.True,False
iONodegetDocNode( iODoc inst );
Document node keeps all 1st level nodes.
instDoc instance.*
const char*getEncoding( void );
Get XML encoding for serialize.
char*getEncodingProperty( void );
Get XML encoding as a property:
intgetInt( iODoc inst, const char* nodename, const char* attrname, int defval );
Search for a given attribute in the given node.
instDoc instance.*
nodenameNode name.*
attrnameAttribute name.*
defvalDefault value if attribute or node is not found in the document.*
iONodegetRootNode( iODoc inst );
This is probably what you want.
instDoc instance.*
const char*getStr( iODoc inst, const char* nodename, const char* attrname, const char* defval );
Search for a given attribute in the given node.
instDoc instance.*
nodenameNode name.*
attrnameAttribute name.*
defvalDefault value if attribute or node is not found in the document.*
BooleanisHTMLEscapes( void );
Is HTML escapes set.
BooleanisIgnoreCase( void );
Ignoring case in node and attribute names.
BooleanisUTF2Latin( void );
Is UTF-8 decoded to Latin.
BooleanisUTF8Encoded( iODoc inst );
Is XML UTF-8 encoded.
instDoc instance.*
BooleanisUTF8Encoding( void );
UTF-8 encoding for serializing.
BooleanisUniCodeEscapes( void );
Is UniCode escapes set.
char*node2String( iONode node, Boolean escaped );
Represents a node recursive as string.
nodeNode instance.*
escapedWrite attribute values escaped.*
iODocparse( const char* xml );
Parses given buffer.
xmlXML buffer to parse.*
voidsetEncoding( const char* enc );
Set XML encoding for serialize.
encEncoding.*
voidsetHTMLEscapes( Boolean html );
Set HTML escapes.
htmlDefault is False.*
voidsetIgnoreCase( Boolean ignore );
Ignoring case in node and attribute names.
ignoreDefault is True.*
voidsetUTF2Latin( Boolean decode );
Is UTF-8 decoded to Latin.
decodeDefault is True.*
voidsetUniCodeEscapes( Boolean uni );
Set UniCode escapes.
uniDefault is False.*
voidsetXMLProlog( Boolean prolog );
Add XML Prolog.
prologDefault is True.*

5. object Ebcdic

Converter for ASCII - EBCDIC.
Summary of object Ebcdic
typedefenum {CODEPAGE_DEFAULT=0,CODEPAGE_1252=1252,CODEPAGE_437=437,CODEPAGE_850=437} codepage
CodePage.
char*Ascii2Ebcdic( iOEbcdic inst, char* ascii, int count );
Converts ascii into ebcdic.
instEbcdic instance.*
asciiAscii buffer.*
countNumber of chars to convert.*
char*Ebcdic2Ascii( iOEbcdic inst, char* ebcdic, int count );
Converts ebcdic into ascii.
instEbcdic instance.*
ebcdicEbcdic buffer.*
countNumber of chars to convert.*
char*Ebcdic2ExtAscii( iOEbcdic inst, char* ebcdic, int count );
Converts ebcdic into ascii.
instEbcdic instance.*
ebcdicEbcdic buffer.*
countNumber of chars to convert.*
char*Ebcdic2TrueAscii( iOEbcdic inst, char* ebcdic, int count );
Converts ebcdic into ascii.
instEbcdic instance.*
ebcdicEbcdic buffer.*
countNumber of chars to convert.*
chargetAscii( iOEbcdic inst, char ebcdic );
Gets the ascii coding for the given ebcdic code.
instEbcdic instance.*
ebcdicEbcdic char.*
chargetEbcdic( iOEbcdic inst, char ascii );
Gets the ebcdic coding for the given ascii code.
instEbcdic instance.*
asciiAscii char.*
iOEbcdicinst( codepage CodePage, const char* converterfile );
Object creator.
CodePageCodepage to use for converting.*
converterfileOptional converterfile in XML format.*

6. object Event

Event semaphore.
Summary of object Event
iOEventinst( const char* name, Boolean create );
Object creator.
nameEvent name.*
createCreate event if not exist.*
Booleanreset( iOEvent inst );
Reset the event.
instEvent instance.*
Booleanset( iOEvent inst );
Set the event.
instEvent instance.*
Booleantrywait( iOEvent inst, int time );
Wait a given time for event to become posted.
instEvent instance.*
timeTime to wait in ms.*ms
Booleanwait( iOEvent inst );
Wait for event to become posted.
instEvent instance.*

7. object File

File helper object.
Summary of object File
typedefenum {OPEN_WRITE=0, OPEN_READONLY=1, OPEN_APPEND=2, OPEN_READWRITE=3} openmode
CodePage.
const const char*FUSER_RC = R
Use the fusers returncode to determine the access state.
const const char*FUSER_FILE = F
Redirect the fuser output into a tempfile to determine the access state.
Booleanaccess( const char* filename );
Test for read permission.
filenameFile path and name.*
Booleanappend( iOFile inst, const char* buffer, long size );
Appends a buffer to the file.
instFile instance.*
bufferData buffer.*
sizeSize of databuffer.*
Booleancd( const char* pathname );
Change the working directory.
pathnameRelative or absolute.*
Booleanclose( iOFile inst );
Closes the file. It does not cleanup this object.
instFile instance.*
voidconvertPath2OSType( const char* pathname );
Changes the separators according the OS.
pathnameRelative.*
Booleancp( const char* src, const char* dst );
Copies a file.
srcSource file.*
dstDestination file.*
Booleanexist( const char* name );
Checks for file or directory existence.
nameRelative or absolute.*
longfileSize( const char* filename );
Gets the filesize in bytes.
filenameFile path and name.*
longfileTime( const char* filename );
Gets the modification time for the given file.
filenameFile path and name.*
Booleanflush( iOFile inst );
Writes all buffered byte on disk.
instFile instance.*
Booleanfmt( iOFile inst, const char* fstr, ... );
Writes a formatted string into the file.
instFile instance.*
fstrFormat string.*
Arguments.*
Booleanforcerename( const char* oldname, const char* newname );
Renames a file, target will be removed if the newname already exist.
oldnameOld filename.*
newnameNew filename.*
const char*getFilename( iOFile inst );
Gets the filename used by this file object.
instFile instance.*
char*getPath( const char* path );
Returns a new allocated path string.
pathFile path and name.*
intgetRc( iOFile inst );
Get the latest error.
instFile instance.*
longgetReaded( iOFile inst );
Gets the count of the readed bytes.
instFile instance.*
FILE*getStream( iOFile inst );
instFile instance.*
longgetWritten( iOFile inst );
Gets the count of the written bytes.
instFile instance.*
longgetpos( iOFile inst );
Gets the filepointer position.
instFile instance.*
iOFileinst( const char* path, int openflag );
Object creator.
pathFile path and name.*
openflagHow to open this file. See typedef openmode.*
BooleanisAbsolute( const char* path );
Checks if given path is absolute.
pathPath to check.*
BooleanisAccessed( const char* filename );
Checks with fuser if the file is accessed by another process.
filenamePath and filename.*
BooleanisDirectory( const char* filename );
True if given name points to a directory.
filename*
BooleanisRegularFile( const char* filename );
False if given name points not to a regular file.
filename*
Booleanmkdir( const char* dirname );
Make directory.
dirnameDirectory path and name.*
char*pwd( void );
The process working directory.
Booleanread( iOFile inst, char* buffer, long size );
Reads from file; True if successful.
instFile instance.*
bufferRead buffer.*
sizeNumber of bytes to read.*
Booleanremove( const char* filename );
Removes the given file.
filenameFile path and name.*
Booleanrename( const char* oldname, const char* newname );
Renames a file.
oldnameOld filename.*
newnameNew filename.*
Booleanreopen( iOFile inst, Boolean truncate );
Reopens this file.
instFile instance.*
truncateTruncates the file contents if set to true! Otherwise it is opened in appending mode.*
Booleanrewind( iOFile inst );
Sets the filepointer to the beginning of the file.
instFile instance.*
const char*ripPath( const char* filename );
Returns a pointer to the filename.
filenameFile path and name.*
Booleanrmdir( const char* path );
Removes given directory.
path*
voidsetFilename( iOFile inst, const char* filename );
Sets the filename to use with this object.
instFile instance.*
filenameThe (new) filenam to use.*
voidsetFuser( const char* filename );
Sets the fuser command to use for isAccessed.
filenamePath and filename of the fuser command.*
voidsetFuserUsage( const char* usage );
The Linux fuser returns a useable rc. With all other unixes we must use a temp file.
usageR for returncode and F for file.R,F
BooleansetfileTime( const char* filename, long filetime );
Sets the modification time for the given file.
filenameFile path and name.*
filetimeNew file modification time.*
Booleansetpos( iOFile inst, long offset );
Sets the filepointer to the given offset.
instFile instance.*
offsetThe new filepointer offset.*
longsize( iOFile inst );
Get the filesize in bytes.
instFile instance.*
Booleanwrite( iOFile inst, const char* buffer, long size );
Write to file; True if successful.
instFile instance.*
bufferWrite buffer.*
sizeNumber of bytes to write.*
BooleanwriteStr( iOFile inst, const char* str );
Appends a string to the file.
instFile instance.*
strNull terminated string.*

8. object GZip

GNU ZIP wrapper.
Summary of object GZip
Booleancompress( iOGZip inst );
instXmlh instance.*
BooleandeCompress( iOGZip inst );
instXmlh instance.*
intgetRc( iOGZip inst );
instXmlh instance.*
iOGZipinst( const char* fileName );
Object creator.

9. object JS

JoyStick support.
Summary of object JS
typedefvoid(*jsListener )( int dev, int type, int number, int value, unsigned long msec )
intinit( iOJS inst, int* devicemap );
instJS instance.*
devicemapbit 0 = /dev/js0...*
iOJSinst( void );
Object creator.
BooleansetListener( iOJS inst, jsListener listener, int devnr );
Set an JS listener.
instJS instance.*
listener*
devnrDevice number: /dev/js0.../dev/jsn*
voidstart( iOJS inst );
instJS instance.*

10. object Lib

Library helper object.
Summary of object Lib
const void*getProc( iOLib inst, const char* procname );
Get a library procedure.
instLib instance.*
procnameProcedure name.*
iOLibinst( const char* name );
Object creator.
nameLibrary path and name.*

11. object List

List helper object.
Summary of object List
typedefint(*comparator)(obj* o1, obj* o2)
voidadd( iOList inst, obj object );
Adds an object to the list.
instList instance.*
objectObject to add.*
voidclear( iOList inst );
Empties the list.
instList instance.*
objfirst( iOList inst );
Gets the first object from the list.
instList instance.*
objget( iOList inst, int pos );
Gets an object from the list by position.
instList instance.*
posPosition.*
intgetIndex( iOList inst );
Gets the current pointer position.
instList instance.*
voidinsert( iOList inst, int pos, obj object );
Inserts an object into the list.
instList instance.*
posInsert position.*
objectObject to add.*
iOListinst( void );
Object creator.
objnext( iOList inst );
Gets the next object from the list.
instList instance.*
objremove( iOList inst, int pos );
Removes an object from the list by position.
instList instance.*
posRemove position.*
objremoveObj( iOList inst, obj object );
Removes an object from the list by reference.
instList instance.*
objectobject to be removed.*
voidreplace( iOList inst, int pos, obj object );
Replaces an object.
instList instance.*
posInsert position.*
objectNew object.*
intsize( iOList inst );
Gets the number of objects currently in the list.
instList instance.*
voidsort( iOList inst, comparator comp );
Sorts this list.
instList instance.*
compComparator function.*

12. object Map

Hashmap.
Summary of object Map
voidclear( iOMap inst );
Clear the map.
instMap instance.*
objfirst( iOMap inst );
Get the first item from the map.
instMap instance.*
objget( iOMap inst, const char* key );
Get an item from the map.
instMap instance.*
keyKey associated with an object.*
iOListgetList( iOMap inst );
Get all mapped objects as a list.
instMap instance.*
Booleanhaskey( iOMap inst, const char* key );
Check if a map entry exist with the given key.
instMap instance.*
keyThe key to check.*
iOMapinst( void );
Map object creator.
objnext( iOMap inst );
Get the next item from the map.
instMap instance.*
voidput( iOMap inst, const char* key, obj val );
Put a new item in the map.
instMap instance.*
keyKey to associate with object.*
valAn object ot put in the map.*
objremove( iOMap inst, const char* key );
Remove an item from the map.
instMap instance.*
keyKey associated with an object.*
intsize( iOMap inst );
Get the size of the map. (Number of objects in the map.)
instMap instance.*

13. object Mem

Memory operation helper.
Summary of object Mem
typedefenum {MEMTYPE_ALLOC=0,MEMTYPE_REALLOC,MEMTYPE_CHECK,MEMTYPE_FREE} memOpType
Memory operation type.
typedefenum {RocsAttrID=0, RocsCmdLnID, RocsDirID, RocsDocID, RocsEventID, RocsFileID, RocsLibID, RocsListID, RocsMapID, RocsMutexID, RocsNodeID, RocsQueueID, RocsSerialID, RocsSocketID, RocsStrID, RocsStringID, RocsSystemID, RocsThreadID, RocsTraceID, RocsEbcdicID, RocsMsgID, RocsStrTokID, RocsLASTID} RocsMemID
For internal use only.
macroallocMem(size)MemOp.alloc(size,__FILE__,__LINE__)
Macro for allocating memory.
macroreallocMem(p,size)MemOp.realloc(p,size,__FILE__,__LINE__)
Macro for re-allocating memory.
macrofreeMem(p)MemOp.free(p,__FILE__,__LINE__)
Macro for freeing memory.
macroallocIDMem(size,id)MemOp.allocTID(size,id,__FILE__,__LINE__)
For internal use only.
macrofreeIDMem(p,id)MemOp.freeTID(p,id,__FILE__,__LINE__)
For internal use only.
void*alloc( long size, const char* file, int line );
Allocate memory and records sourcefile and line. (Use macro allocMem.)
sizeMemory size to allocate.*
fileSourcefile.*
lineSourceline.*
void*allocTID( long size, int id, const char* file, int line );
Allocate memory and records sourcefile and line. (Use macro allocIDMem.)
sizeMemory size to allocate.*
idSee typedef RocsMemID.*
fileSourcefile.*
lineSourceline.*
voidbasecpy( void* dst, void* src, int asize, int tsize, void* data );
A special copy function for creating rocs-based objects.
dstDestination.*
srcSource.*
asize*
tsize*
dataObject date.*
char*chr( const void* buffer, char c, int size );
Find a char in memoryblock.
bufferBuffer to search.*
cChar to look for.*
sizeSize of memoryblock to be searched.*
Booleancmp( const void* dst, const void* src, int size );
Compairs two memory blocks.
dstDestination.*
srcSource.*
sizeSize of source to be compaired.*
voidcopy( void* dst, const void* src, int size );
Copies a memory block.
dstDestination.*
srcSource.*
sizeSize of source to be copied.*
const long*dumpAllocCntID( void );
Dumps allocation count by ID.
voidfree( void* p, const char* file, int line );
Free up memory and records sourcefile and line. (Use macro freeMem.)
pMemory block to free up.*
fileSourcefile.*
lineSourceline.*
voidfreeObj( void** p );
Free up obj memory.
pObject to free up.*
voidfreeTID( void* p, int id, const char* file, int line );
Free up memory and records sourcefile and line. (Use macro freeIDMem.)
pMemory block to free up.*
idSee typedef RocsMemID.*
fileSourcefile.*
lineSourceline.*
longgetAllocCntID( int id );
Returns allocation count by ID.
idSee typedef RocsMemID.*
longgetAllocCount( void );
Returns number of allocated memory objects.
longgetAllocSize( void );
Returns total allocated memory size.
intgetDumpSize( void );
const char*getLastOperation( void );
voidinit( void );
void*realloc( void* p, long size, const char* file, int line );
Re-Allocate memory and records sourcefile and line. (Use macro reallocMem.)
pMemory block to re-allocate.*
sizeNew memory size to allocate.*
fileSourcefile.*
lineSourceline.*
voidresetDump( void );
voidset( void* p, int val, int size );
Initializes a memory block.
pMemory block.*
valInit value.*
sizeSize to be initialized.*
voidsetDebug( Boolean debug );
If set it prints for every allocation and free a line.
debugDebug flag.*

14. object Mime64

Mime64 converter
Summary of object Mime64
Booleandecode( const char* infile, const char* outfile );
decode the input file into it's
Booleanencode( const char* infile, const char* outfile );
encode the input file into mime64

15. object Msg

Message object.
Summary of object Msg
typedefenum {VOID_DATA, OBJ_DATA, STR_DATA } usrdatatype
Cargo type.
intgetEvent( iOMsg inst );
instMsg instance.*
objgetSender( iOMsg inst );
instMsg instance.*
intgetTimer( iOMsg inst );
instMsg instance.*
void*getUsrData( iOMsg inst );
instMsg instance.*
usrdatatypegetUsrDataType( iOMsg inst );
instMsg instance.*
iOMsginst( obj sender, int event );
Object creator.
senderReference to sender.*
eventEvent type.*
voidsetEvent( iOMsg inst, int event );
instMsg instance.*
eventEvent type.*
voidsetTimer( iOMsg inst, int timer );
instMsg instance.*
timerTimer*
voidsetUsrData( iOMsg inst, void* usrdata, usrdatatype type );
instMsg instance.*
usrdataCargo.*
typeCargo type.*

16. object Mutex

Mutex object.
Summary of object Mutex
intgetRc( iOMutex inst );
Get last error code.
instMutex instance.*
iOMutexinst( const char* name, Boolean create );
Object creator
nameMutex name.*
createCreate a mutex when not exist.*
Booleanpost( iOMutex inst );
Release the mutext. (release, unlock)
instMutex instance.*
Booleantrywait( iOMutex inst, int time );
Wait for the mutext.
instMutex instance.*
timeTime to wait for the mutext.*ms
Booleanwait( iOMutex inst );
Wait for the mutext. (request, lock)
instMutex instance.*

17. object Node

DOM node object.
Summary of object Node
typedefenum {ELEMENT_NODE, TEXT_NODE, PROPERTY_NODE, REMARK_NODE, VARIABLE_NODE} nodetype
Node type.
voidaddAttr( iONode inst, iOAttr attr );
Add an attribute.
instNode instance.*
attrAttribute object.*
voidaddChild( iONode inst, iONode child );
Add a child node.
instNode instance.*
childChild node.*
iOAttrfindAttr( iONode inst, const char* attrname );
Search for an attribute with the given name.
instNode instance.*
attrname*
iONodefindNextNode( iONode inst, iONode node );
Find next node with the same name.
instNode instance.*
nodeNode reference of previous find orfindNext.*
iONodefindNode( iONode inst, const char* nodename );
Search for a child node with the given name.
instNode instance.*
nodename*
iOAttrgetAttr( iONode inst, int idx );
Get an attribute by index.
instNode instance.*
idxAttribute index.*
intgetAttrCnt( iONode inst );
Get the number of attributes.
instNode instance.*
BooleangetBool( iONode inst, const char* attrname, Boolean defval );
Get an attribute value as boolean.
instNode instance.*
attrnameAttribute name.*
defvalValue to return if attribute is not found.*
iONodegetChild( iONode inst, int idx );
Get an child node by index.
instNode instance.*
idxChild node index.*
intgetChildCnt( iONode inst );
Get the number of child nodes.
instNode instance.*
doublegetFloat( iONode inst, const char* attrname, double defval );
Get an attribute value as float.
instNode instance.*
attrnameAttribute name.*
defvalValue to return if attribute is not found.*
intgetInt( iONode inst, const char* attrname, int defval );
Get an attribute value as integer.
instNode instance.*
attrnameAttribute name.*
defvalValue to return if attribute is not found.*
longgetLong( iONode inst, const char* attrname, long defval );
Get an attribute value as long.
instNode instance.*
attrnameAttribute name.*
defvalValue to return if attribute is not found.*
const char*getName( iONode inst );
Get the node name.
instNode instance.*
iONodegetNode( iONode inst, const char* nodename );
Same as findNode but if no node is found it creates one.
instNode instance.*
nodename*
iONodegetParent( iONode inst );
Get the parent node.
instNode instance.*
const char*getStr( iONode inst, const char* attrname, const char* defval );
Get an attribute value as string.
instNode instance.*
attrnameAttribute name.*
defvalValue to return if attribute is not found.*
nodetypegetType( iONode inst );
Get the node type.
instNode instance.*
iONodeinst( const char* name, iONode parent, nodetype type );
Object creator
nameNode name.*
parentParent node.*
typeNode type.*
iONodemergeNode( iONode nodeA, iONode nodeB, Boolean overwrite, Boolean recursive, Boolean keepid );
Merge nodeB into A.
nodeANode A.*
nodeBNode B.*
overwriteOverwrites existing attributes.*
recursivemerge childnodes*
keepiddo not overwrite id attributes at first level*
voidremoveAttr( iONode inst, iOAttr attr );
Removes an attribute.
instNode instance.*
attrAttribute object.*
voidremoveChild( iONode inst, iONode child );
Remove a child node.
instNode instance.*
childChild node.*
voidsetBool( iONode inst, const char* attrname, Boolean val );
Set an attribute value as boolean.
instNode instance.*
attrnameAttribute name.*
valValue to assing given attribute.*
voidsetFloat( iONode inst, const char* attrname, double val );
Set an attribute value as float.
instNode instance.*
attrnameAttribute name.*
valValue to assign.*
voidsetInt( iONode inst, const char* attrname, int val );
Set an attribute value as integer.
instNode instance.*
attrnameAttribute name.*
valValue to assing given attribute.*
voidsetLong( iONode inst, const char* attrname, long val );
Set an attribute value as long.
instNode instance.*
attrnameAttribute name.*
valValue to assign.*
voidsetName( iONode inst, const char* name );
Set the node name.
instNode instance.*
nameNew node name.*
voidsetParent( iONode inst, iONode parent );
Change or set parent of this node.
instNode instance.*
parentParent node.*
voidsetStr( iONode inst, const char* attrname, const char* val );
Set an attribute value as string.
instNode instance.*
attrnameAttribute name.*
valValue to assing given attribute.*
voidsetType( iONode inst, nodetype type );
Set the node type.
instNode instance.*
typeNode type.*
char*toEscString( iONode inst );
Serialize this node with escaped attribute values.
instNode instance.*

18. object Queue

Queue object.
Summary of object Queue
typedefenum {low=0,normal=1,high=2} q_prio
Priority.
intcount( iOQueue inst );
Number of messages in the queue.
instQueue instance.*
objget( iOQueue inst );
Read a message.
instQueue instance.*
iOQueueinst( int size );
Object creator.
sizeSize of queue.*
BooleanisEmpty( iOQueue inst );
Are messages in the queue?
instQueue instance.*
Booleanpost( iOQueue inst, obj object, q_prio prio );
Post a message.
instQueue instance.*
objectObject to post.*
prioMessage priority.*
objwaitPost( iOQueue inst );
Wait for a messages.
instQueue instance.*

19. object Res

Resource helper object.
Summary of object Res
const char*getMenu( iORes inst, const char* key );
Get a message by key.
instres instance.*
keyArgument key.*
const char*getMsg( iORes inst, const char* key );
Get a message by key.
instres instance.*
keyArgument key.*
const char*getTip( iORes inst, const char* key );
Get a tooltip by key.
instres instance.*
keyArgument key.*
BooleanhasKey( iORes inst, const char* key );
Test if the given key is in the XML.
instRes instance.*
keyArgument key.*
iOResinst( const char* xml, const char* lang );
Creates a resource object.
xmlMessages XML as C-String.*
langLanguage.(de,en...)*

20. object Serial

Serial communication.
Summary of object Serial
typedefenum {none=0,even=1,odd=2} serial_parity
typedefenum {cts=1,dsr=2,xon=3} serial_flow
typedefenum {onestopbit=1,twostopbits=2} serial_stopbits
typedefenum {eight=8,seven=7} serial_databits
typedefenum {undefined=0,mm=1,dcc=2,mma=3} serial_mode
typedefserial_bps
intavailable( iOSerial inst );
Get number of bytes available to read.
instSerial instance.*
Booleanclose( iOSerial inst );
Close the port.
instSerial instance.*
voidflush( iOSerial inst );
clear output buffer
instSerial instance.*
intgetRc( iOSerial inst );
Get last error.
instSerial instance.*
intgetWaiting( iOSerial inst );
Get number of bytes waiting to send.
instSerial instance.*
iOSerialinst( const char* device );
Object creator.
deviceDevice name like com1 or ttyS0.*
BooleanisCTS( iOSerial inst );
Control To Send.
instSerial instance.*
BooleanisDSR( iOSerial inst );
Data Set Ready.
instSerial instance.*
BooleanisRI( iOSerial inst );
Ring Indicator.
instSerial instance.*
BooleanisUartEmpty( iOSerial inst, Boolean soft );
instSerial instance.*
softno direct IO if soft ist set*
Booleanopen( iOSerial inst );
Try to open and to initialize the port.
instSerial instance.*
Booleanread( iOSerial inst, char* buffer, int count );
Read some bytes.
instSerial instance.*
bufferRead buffer.*
countNumber of bytes to read.*
voidsetBlocking( iOSerial inst, Boolean blocking );
Set blocking/non-blocking io.
instSerial instance.*
blockingBlocking mode.*
voidsetCTS( iOSerial inst, Boolean cts );
Clear To Send.
instSerial instance.*
ctson-off*
voidsetDTR( iOSerial inst, Boolean dtr );
Data Terminal Ready.
instSerial instance.*
dtron-off*
voidsetDivisor( iOSerial inst, int divisor );
Custom Divisor.
instSerial instance.*
voidsetFlow( iOSerial inst, serial_flow flow );
Set data flow control.
instSerial instance.*
flowData flow control to use.*
voidsetLine( iOSerial inst, serial_bps bps, serial_databits databits, serial_stopbits stopbits, serial_parity parity );
Set line settings.
instSerial instance.*
bpsLine speed.*
databits*
stopbits*
parity*
voidsetOutputFlow( iOSerial inst, Boolean flow );
set output flow on off
instSerial instance.*
flowon-off*
voidsetPortBase( iOSerial inst, int addr );
Set data flow control.
instSerial instance.*
addrIO base address of device*
voidsetRTS( iOSerial inst, Boolean rts );
Request To Send.
instSerial instance.*
rtson-off*
voidsetSerialMode( iOSerial inst, serial_mode mode );
Set uart speed for MM or DCC
instSerial instance.*
mode*
voidsetTimeout( iOSerial inst, int wtime, int trime );
Set timeout.
instSerial instance.*
wtimeWrite timeout.*ms
trimeRead timeout.*ms
voidwaitMM( iOSerial inst, int usperiod, int uspause );
Do busy wait for MM protocol
instSerial instance.*
usperiodWait time from start of packet to start of packet*
uspauseWait time from end of packet to start of packet*
Booleanwrite( iOSerial inst, const char* buffer, int count );
Write some bytes.
instSerial instance.*
bufferWrite buffer.*
countNumber of bytes to write.*

21. object Socket

Socket communication.
Summary of object Socket
typedefvoid (*socket_listener)(unsigned char* in,int len)
Socket Listener.
iOSocketaccept( iOSocket inst );
Accept client connections.
instSocket instance.*
Booleanbind( iOSocket inst );
instSocket instance.*
Booleanconnect( iOSocket inst );
Connect socket with target.
instSocket instance.*
voiddisConnect( iOSocket inst );
Disconnect from remote peer.
instSocket instance.*
Booleanfmt( iOSocket inst, const char* format, ... );
Formats a string.
instSocket instance.*
formatFormat rules.*
Multiple parameters.*
char*getMAC( const char* device );
deviceDevice name to query.*
longgetPeeked( iOSocket inst );
Get number of peeked bytes.
instSocket instance.*
const char*getPeername( iOSocket inst );
instSocket instance.*
intgetRc( iOSocket inst );
Get last error.
instSocket instance.*
longgetReceived( iOSocket inst );
Get number of readed bytes.
instSocket instance.*
longgetSended( iOSocket inst );
Get number of written bytes.
instSocket instance.*
FILE *getStream( iOSocket inst );
Get socket stream object.
instSocket instance.*
const char*gethostname( void );
Get local hostname.
iOSocketinst( const char* host, int port, Boolean ssl, Boolean udp );
Object creator.
hostTarget hostname.*
portTarget or server port.*
sslSSL mode.*
udpUDP mode.*
iOSocketinstSSLserver( int port, const char* certFile, const char* keyFile );
Object creator.
portTarget or server port.*
certFile*
keyFile*
BooleanisBroken( iOSocket inst );
Is connection broken?
instSocket instance.*
BooleanisConnected( iOSocket inst );
Socket is connected.
instSocket instance.*
BooleanisOpenSSL( void );
OpenSSL support is enabled.
BooleanisTimedOut( iOSocket inst );
Check if last returncode is a ETIMEDOUT error.
instSocket instance.*
Booleanpeek( iOSocket inst, char* buffer, int size );
Are some bytes waiting to be read?
instSocket instance.*
bufferRead buffer.*
sizeSize of buffer.*
Booleanread( iOSocket inst, char* buffer, int size );
Read bytes.
instSocket instance.*
bufferRead buffer.*
sizeSize of buffer.*
char*readStr( iOSocket inst, char* buffer );
Read til a terminating zero is detected.
instSocket instance.*
bufferRead buffer.*
charreadc( iOSocket inst );
Read one character.
instSocket instance.*
char*readln( iOSocket inst, char* buffer );
Read till a linefeed is detected.
instSocket instance.*
bufferRead buffer.*
intrecvfrom( iOSocket inst, char* buffer, int size );
Receive udp message.
instSocket instance.*
bufferRead buffer.*
sizeSize of buffer.*
voidreset( iOSocket inst );
Reset the socket; clear flags.
instSocket instance.*
Booleansendto( iOSocket inst, char* buffer, int size );
Send udp message.
instSocket instance.*
bufferWrite buffer.*
sizeSize of buffer.*
BooleansetBlocking( iOSocket inst, Boolean blocking );
Set blocking.
instSocket instance.*
blockingSet True for blocking mode.*
BooleansetKeepalive( iOSocket inst, Boolean keepalive );
instSocket instance.*
keepalive*
voidsetListener( iOSocket inst, socket_listener listener );
NOT IMPLEMENTED!.
instSocket instance.*
listenerListener.*
BooleansetRcvTimeout( iOSocket inst, int timeout );
Set timeout value for reading.
instSocket instance.*
timeoutTimeout value.*ms
BooleansetSndTimeout( iOSocket inst, int timeout );
Set timeout value for writing.
instSocket instance.*
timeoutTimeout value.*ms
Booleanwrite( iOSocket inst, const char* buffer, int size );
Write bytes.
instSocket instance.*
bufferWrite buffer.*
sizeSize of buffer.*
Booleanwritec( iOSocket inst, char c );
Write one character.
instSocket instance.*
cChar to write.*

22. object Str

String operation helper.
Summary of object Str
char*byteToStr( unsigned char* bin, int len );
Converts binary data into a hex string like 0AFE...
binInput bytes.*
lenNumber of bytes to translate.*
char*cat( char* dest, const char* src );
dest*
src*
char*copy( char* dst, const char* src );
Copies a string.
dst*
src*
intcopynz( char* snz, int snzlen, const char* str );
Copies a zero terminated string as a non-zero terminated string.
snzNon-zero buffer.*
snzlenNon-zero buffer length.*
strInput string.*
char*createStamp( void );
Creates a timestamp: YYYYmmdd.hhMMss.SSS.
char*createStampNoDots( void );
Creates a timestamp: YYYYmmddhhMMssSSS.
char*decode4URL( const char* url );
replace url escapes with special chars
urlURL to decode*
char*dup( const char* src );
Duplicates a string.
src*
char*encode4URL( const char* url );
replace special chars with url escapes
urlURL to encode*
BooleanendsWith( const char* str1, const char* str2 );
Check if str1 ends with str2.
str1String to check.*
str2Ending.*
BooleanendsWithi( const char* str1, const char* str2 );
Check if str1 ends with str2. (ignoring case)
str1String to check.*
str2Ending.*
Booleanequals( const char* str1, const char* str2 );
Compares two strings.
str1*
str2*
Booleanequalsi( const char* str1, const char* str2 );
Equals ignore case.
str1*
str2*
Booleanequalsn( const char* str1, const char* str2, int cnt );
Equals till number off char is reached.
str1*
str2*
cntNumber of chars to compare*
Booleanequalsni( const char* str1, const char* str2, int cnt );
Equals ignore case till number off char is reached.
str1*
str2*
cntNumber of chars to compare*
char*find( const char* str, const char* substr );
Finds a substring.
str*
substr*
char*findc( const char* str, char c );
Find the first occurrence of a character.
strString to investigate.*
cCharacter to look for.*
char*findi( const char* str, const char* substr );
Finds a substring ignoring case.
str*
substr*
char*fmt( const char* format, ... );
Formats a string.
formatFormat rules.*
Multiple parameters.*
char*fmtb( char* buffer, const char* format, ... );
Formats a string into a buffer.
bufferBuffer.*
formatFormat rules.*
Multiple parameters.*
voidfree( char* str );
Free up a string allocation.
strString allocation.*
intgetCntLinefeeds( const char* str );
Returns number of linefeed chars found.
str*
char*getExtension( const char* str );
Returns a pointer to the string extension: [readme.txt] would return a pointer to [txt].
str*
char*getLine( const char* str, int nr );
Returns pointer to the specified line.
str*
nrLine number.*
char*getNextLine( const char* str, int* nr );
Returns pointer to the next line.
str*
nrLine number.*
voidint2snz( char* snz, int snzlen, int val );
Converts an integer into a non-zero string.
snzNon-zero buffer.*
snzlenNon-zero buffer length.*
valInput value.*
char*isoDate( long tt );
Creates an ISO date string: YYYY-mm-dd
tt*
char*isoTime( long tt );
Creates an ISO time string: hh:MM:ss
tt*
intlen( const char* str );
Calculates the string length.
str*
voidlong2snz( char* snz, int snzlen, long val );
Converts an long into a non-zero string.
snzNon-zero buffer.*
snzlenNon-zero buffer length.*
valInput value.*
intreplaceAll( char* str, char charA, char charB );
Replace all charA's with charB
strString to change.*
charAChar to replace*
charBReplacement*
char*replaceAllSubstitutions( const char* str );
Replace all environment variables with there current values.
strInput string.*
char*snz2sz( const char* snz, int snzlen );
Converts an non-zero string as a zero terminated string.
snzNon-zero string.*
snzlenNon-zero string length.*
BooleanstartsWith( const char* str1, const char* str2 );
Check if str1 starts with str2.
str1String to check.*
str2Beginning.*
BooleanstartsWithi( const char* str1, const char* str2 );
Check if str1 starts with str2. (ignoring case)
str1String to check.*
str2Beginning.*
unsigned char*strToByte( const char* str );
Converts a hex string into binary data
strInput string*
const char*strlwr( const char* str );
Converts all chars into lowercase.
str*
const char*strupr( const char* str );
Converts all chars into uppercase.
str*
char*trim( char* str );
Removes leading and trailing blanks.
strString to trim.*

23. object StrTok

String tokenizer object.
Summary of object StrTok
intcountTokens( iOStrTok inst );
Get number of tokens.
instString instance.*
BooleanhasMoreTokens( iOStrTok inst );
There are more tokens left to read.
instString instance.*
iOStrTokinst( const char* str, char sep );
Object creator.
strInitial string value.*
sepString separator.*
const char*nextToken( iOStrTok inst );
A token.
instString instance.*

24. object String

String object.
Summary of object String
iOStringinst( const char* str );
Object creator.
strInitial string value.*
intlen( iOString inst );
String length.
instString instance.*
const char*str( iOString inst );
String value.
instString instance.*

25. object System

System utilities.
Summary of object System
typedefenum {OSTYPE_UNIX, OSTYPE_DOS} ostype
OS type.
const intvmajor = 1
const intvminor = 2
const intpatch = 0
const const char*builddate = $__DATE__
const const char*buildtime = $__TIME__
BooleanaccessDev( const char* device, Boolean readonly );
check device access
devicedevice name*
BooleanaccessPort( int from, int num );
try to get port access
fromport base address*
voidbeep( void );
Beeps.
char*cp1252toISO885915( const char* str );
Translates Windows CP1252 into Latin 15.
strCP1252 encoded string.*
const char*getBuild( void );
Get the Rocs build string.
const char*getErrStr( int error );
Translates an error code into a string.
error*
chargetFileSeparator( void );
char*getGUID( const char* macdev );
Get global unique ID. (32 chars long)
macdevMay be NULL to use the default device for getting the MAC address.*
intgetMillis( void );
ostypegetOSType( void );
chargetPathSeparator( void );
chargetPathSeparator4OS( ostype type );
Path separator for a specific OS type.
type*
const char*getProperty( const char* key );
Reads an environment variable.
keyEnvironment variable key.*
const char*getSigStr( int sig );
Translates an signal number into a string.
sig*
unsigned longgetTick( void );
System tick in 10ms.
intgetTime( int* hours, int* minutes, int* seconds );
returns milliseconds
char*getUNC( const char* filepath );
Translates a local path into a UNC.
filepath*
const char*getUserName( void );
Login username.
const char*getWSName( void );
Workstation name.
intgetpid( void );
Process ID.
iOSysteminst( void );
Object creator. (Singleton)
BooleanisUnix( void );
BooleanisWindows( void );
char*latin2utf( const char* latinstr );
Translates Latin 15 into UTF-8.
latinstrLatin 15 encoded string.*
bytereadPort( int port );
read a byte to the port
BooleanreleasePort( int from, int num );
release the port access
fromport base address*
BooleansetAdmin( void );
intsystem( const char* cmd, Boolean async );
Starts a system command.
cmdCommand.*
asyncStart command async in a separate thread.*
BooleanuBusyWait( int us );
usWait time in us*
char*utf2latin( const char* utfstr );
Translates fitting UTF-8 encodings into Lantin 15.
utfstrUTF-8 encoded string.*
voidwritePort( int port, byte val );
write a byte to the port

26. object Thread

Thread object.
Summary of object Thread
typedefvoid (*thread_run)(void*)
iOThreadfind( const char* name );
Find a thread by name.
nameThread name.*
iOThreadfindById( unsigned long id );
Find a thread by id.
idThread id.*
iOListgetAll( void );
Get a list of all threads.
const char*getName( iOThread inst );
Thread name.
instThread instance.*
void*getParm( iOThread inst );
Get parameter object.
instThread instance.*
objgetPost( iOThread inst );
Get post from the queue. (NULL if nothing is in queue.)
instThread instance.*
unsigned longid( void );
Get current thread id.
iOThreadinst( const char* name, thread_run run, void* parm );
Object creator.
nameThread name.*
runThread runner.*
parmThread parameters. (User defined.)*
BooleanisPause( iOThread inst );
Pause signaled.
instThread instance.*
BooleanisQuit( iOThread inst );
Quit signaled.
instThread instance.*
Booleanjoin( iOThread inst );
Waits for thread termination and returns True if ok.
instThread instance.*
voidkill( iOThread inst );
Kill a thread by reference.
instThread instance.*
voidpause( iOThread inst, Boolean pause );
set pause flag
instThread instance.*
Booleanpost( iOThread inst, obj msg );
Post a message into the queue.
instThread instance.*
msgPost.*
voidrequestQuit( iOThread inst );
Signals thread to stop as soon as possible.
instThread instance.*
voidrequestQuitAll( void );
Signals all thread to stop as soon as possible.
voidsetDescription( iOThread inst, const char* desc );
instThread instance.*
descDescription.*
voidsetHigh( iOThread inst );
Sets the priority to high.
instThread instance.*
voidsetStacksize( iOThread inst, long size );
Change the default stacksize.
instThread instance.*
sizeNew stacksize.*byte
voidsleep( int time );
Sleeps the current thread.
timeTime to sleep.*ms
Booleanstart( iOThread inst );
Starts the thread runner.
instThread instance.*
objwaitPost( iOThread inst );
Get post from the queue. (Wait until post comes in queue.)
instThread instance.*

27. object Trace

Trace object. (Singleton)
Summary of object Trace
typedefvoid(*trcListener )(int level, char* module, char* msg, int rc, Boolean dump)
typedefvoid(*ExceptionListener )(int level, char* msg)
typedefenum {TRCLEVEL_EXCEPTION=0x0001,TRCLEVEL_INFO =0x0002,TRCLEVEL_WARNING=0x0004,TRCLEVEL_DEBUG =0x0008, TRCLEVEL_BYTE =0x0010,TRCLEVEL_METHOD=0x0020,TRCLEVEL_MEMORY =0x0040,TRCLEVEL_PARAM =0x0080, TRCLEVEL_PROTOCOL =0x0100,TRCLEVEL_ERROR =0x0200,TRCLEVEL_PARSE =0x0400,TRCLEVEL_WRAPPER=0x0800, TRCLEVEL_USER1 =0x1000,TRCLEVEL_USER2 =0x2000,TRCLEVEL_MONITOR=0x4000,TRCLEVEL_XMLH =0x8000, TRCLEVEL_USER =0xF000,TRCLEVEL_CALC =0x10000,TRCLEVEL_ALL =0xFFFFFF} tracelevel
Trace levels.
voiddmp( const void* cargo, tracelevel level, int id, const char* buffer, int size );
Trace a binary buffer.
cargoName of calling object or Trace instance.*
levelTrace level.*
idTrace id.*
bufferBuffer to trace.*
sizeSize of buffer.*
voiddump( const void* cargo, tracelevel level, const char* buffer, int size );
Trace a binary buffer.
cargoTrace instance or Object name.*
levelTrace level.*
bufferBuffer to trace.*
sizeSize of buffer.*
iOTraceget( void );
Get's the trace object.
const char*getCurrentFilename( iOTrace inst );
Get the current trace filename.
instTrace instance or NULL.*
intgetDumpsize( iOTrace inst );
Get trace dumpsize.
instTrace instance or NULL.*
const FILE*getF( iOTrace inst );
Get the current trace FILE object.
instTrace instance or NULL.*
const char*getFilename( iOTrace inst );
Get the trace filename.
instTrace instance or NULL.*
tracelevelgetLevel( iOTrace inst );
Get the trace level(s).
instTrace instance or NULL.*
const char*getOS( void );
Get the current operating system.
iOTraceinst( tracelevel level, const char* filename, Boolean toStdErr );
Object creator.
levelTrace level(s) to be traced out.*
filenameTrace filename.*
toStdErrTrace output also to stderr.*
BooleanisStdErr( iOTrace inst );
Get trace to stderr.
instTrace instance or NULL.*
voidprintHeader( void );
Prints the trace header.
voidprintln( const char* fmt, ... );
Prints one line into the trace.
fmtFormat string.*
Variables for the format string.*
voidset( iOTrace inst );
Replace or set the singleton with this one.
instTrace instance or NULL.*
voidsetAppID( iOTrace inst, const char* id );
Sets the application id to use in the trace.
instTrace instance or NULL.*
idApplication ID.*
voidsetDumpsize( iOTrace inst, int size );
Set trace dumpsize.
instTrace instance or NULL.*
sizeNew dumpsize.*
voidsetEbcdicDump( iOTrace inst, Boolean ebcdic );
Dump also an ebcdic column.
instTrace instance or NULL.*
ebcdic*
voidsetExceptionFile( iOTrace inst, Boolean useexceptionfile );
If set, exceptions are also traced in a separate file.
instTrace instance or NULL.*
useexceptionfileActivates an exception file.*
voidsetExceptionListener( iOTrace inst, ExceptionListener listener, Boolean timestamp );
Set an exceptionlistener.
instTrace instance or NULL.*
listener*
timestampSend exceptions with timestamp prefix.*
voidsetFileSize( iOTrace inst, int size );
Change the trace max. filesize.
instTrace instance or NULL.*
sizeNew filesize.*KB
voidsetFilename( iOTrace inst, const char* filename );
Change the trace filename.
instTrace instance or NULL.*
filenameNew filename.*
voidsetInvoke( iOTrace inst, const char* cmd, Boolean async );
Command to invoke when writing a new exception file.
instTrace instance or NULL.*
cmdCommand to invoke.*
asyncInvoke in separate thread.*
voidsetLevel( iOTrace inst, tracelevel level );
Change the trace level(s).
instTrace instance or NULL.*
levelTrace level(s).*
voidsetMainThreadId( unsigned long id );
Set the thread id for main.
id*
voidsetNrFiles( iOTrace inst, int cnt );
Change the number of files before recycling the oldest.
instTrace instance or NULL.*
cntNew number of files.*
voidsetStdErr( iOTrace inst, Boolean tostderr );
Set trace to stderr.
instTrace instance or NULL.*
tostderr*
voidterrno( const char* objectname, tracelevel level, int line, int id, int error, const char* fmt, ... );
Trace.
objectnameName of calling object.*
levelTrace level.*
lineSourceline number.*
idTrace id.*
errorError number to be translated.*
fmtFormat string.*
Variables for format string.*
voidtrace( const void* cargo, tracelevel level, int id, const char* fmt, ... );
Trace.
cargoTrace instance or Object name.*
levelTrace level.*
idTrace id.*
fmtFormat string.*
Variables for format string.*
voidtrc( const char* objectname, tracelevel level, int line, int id, const char* fmt, ... );
Trace.
objectnameName of calling object.*
levelTrace level.*
lineSourceline number.*
idTrace id.*
fmtFormat string.*
Variables for format string.*

28. object WrpInf

Wrapper info object.
Summary of object WrpInf
iOListgetVars( iONode wrp );
Get all var nodes.
wrpWrapper.*
iONodegetWrapper( iOWrpInf inst, const char* wrpname );
Get a wrapper by key.
instres instance.*
wrpnameWrapper name.*
iOWrpInfinst( const char** xmls, int cnt );
Creates a resource object.
xmlsWrapper XML's as C-String.*
cntNumber of xml strings.*

29. object Xmlh

Xmlh protocol helper object.
Summary of object Xmlh
const const char*header_tagname = xmlh
const const char*xml_tagname = xml
const const char*bin_tagname = bin
const intinitAllocSize = 4096
voidaddNode( iOXmlh inst, iONode node );
Add.
instXmlh instance.*
nodeNode to add in the Xmlh.*
const char*getBinName( iOXmlh inst, int idx );
Get filename for bin block by index.
instXmlh instance.*
idxIndex.*
longgetBinSize( iOXmlh inst, int dataIdx );
Get size of bin block by index.
instXmlh instance.*
dataIdxIndex.*
iONodegetNodeByTagName( iOXmlh inst, const char* name, int idx );
Get header childnode by name.
instXmlh instance.*
nameName.*
idxIndex. (Incase of a list of the same nodes.)*
intgetSizeByTagName( iOXmlh inst, const char* name, int idx );
Get size of block by name.
instXmlh instance.*
nameName.*
idxIndex. (Incase of a list of the same nodes.)*
const char*getXmlName( iOXmlh inst, int dataIdx );
Get node for xml block by index.
instXmlh instance.*
dataIdxIndex.*
intgetXmlSize( iOXmlh inst, int idx );
Get size of xml block by index.
instXmlh instance.*
idxIndex.*
inthasBin( iOXmlh inst );
Get number of bin nodes.
instXmlh instance.*
inthasXml( iOXmlh inst );
Get number of xml nodes.
instXmlh instance.*
iOXmlhinst( Boolean create, const char* header_tagname, const char* bin_tagname );
Object creator.
createCreate a new Xmlh.*
header_tagnameOptional tagname as alternative to xmlh.*
bin_tagnameOptional tagname as alternative to bin.*
BooleanisError( iOXmlh inst );
Get error state of Xmlh.
instXmlh instance.*
Booleanread( iOXmlh inst, const byte* buffer, int size );
Reads the Xmlh from buffer. True if complete header is read.
instXmlh instance.*
bufferBuffer with part of Xmlh.*
sizeByte count in buffer.*
voidreset( iOXmlh inst );
instXmlh instance.*