Object Types

Instructions manual





OKit: Object Tree, RPL Virtual Machine and compiler shared library

Copyright (C) 2000 Yann LANDRIN-SCHWEITZER


This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


Author: Yann LANDRIN-SCHWEITZER
Contact: varkhan@free.fr
Homepage: http://varkhan.free.fr/





USES ErrLog.h





Generic OKit_Object methods






Function OKit_ObjectAlloc

OKit_Object OKit_ObjectAlloc() ;
Allocates an empty, undefined object.


Returns
_NULL:if no memory was available
else a new undefined OKit_Object.


Errors
_ENOMEM:if no memory was available



Function OKit_ObjectCopy

OKit_Object OKit_ObjectCopy(OKit_Object obj) ;
Hard-copies an OKit_Object.


Args
_obj:OKit_Object to copy


Returns
_NULL:if a NULL OKit_Object was passed as argument, or no memory was available
else a direct, fully recursive copy of the OKit_Object.


Errors
_EINVAL:if a NULL OKit_Object was passed as argument
_ENOMEM:if no memory was available



Function OKit_ObjectClone

OKit_Object OKit_ObjectClone(OKit_Object obj) ;
Clones an OKit_Object.


Args
_obj:OKit_Object to clone


Returns
_NULL:if a NULL OKit_Object was passed as argument, or no memory was available
else a cloned version of the OKit_Object (flat copy).


Errors
_EINVAL:if a NULL OKit_Object was passed as argument
_ENOMEM:if no memory was available



Function OKit_ObjectDup

OKit_Object OKit_ObjectDup(OKit_Object obj) ;
References an OKit_Object.


Args
_obj:OKit_Object to reference


Returns
_NULL:if a NULL OKit_Object was passed as argument
else the referenced object.


Errors
_EINVAL:if a NULL OKit_Object was passed as argument



Function OKit_ObjectDrop

OKit_Object OKit_ObjectDrop(OKit_Object obj) ;
Dereferences an OKit_Object.


Args
_obj:OKit_Object to dereference


Returns
_NULL:if a NULL OKit_Object was passed as argument
else the dereferenced object.


Errors
_EINVAL:if a NULL OKit_Object was passed as argument



Function OKit_ObjectFree

void OKit_ObjectFree(OKit_Object obj) ;
Frees and OKit_Object if it is unreferenced.


Args
_obj:OKit_Object to free



Function OKit_ObjectType

OKit_Type OKit_ObjectType(OKit_Object obj) ;
Returns the type of an OKit_Object.


Args
_obj:OKit_Object to query


Returns
_-1:if a NULL OKit_Object was passed as argument
else the numeric identifier for the object type.


Errors
_EINVAL:if a NULL OKit_Object was passed as argument



Function OKit_ObjectTypeName

char * OKit_ObjectTypeName(OKit_Type typ) ;
Returns a name for a numeric type identifier.


Args
_obj:OKit_Object to query


Returns
_"":if an unknown type was given
else a unique string usable as a name for that type.



Function OKit_ObjectContent

void * OKit_ObjectContent(OKit_Object obj) ;
Returns a pointer on the content of an OKit_Object.


Args
_obj:OKit_Object to query


Returns
_-1:if a NULL OKit_Object was passed as argument
else a pointer to the OKit_Object's content.


Errors
_EINVAL:if a NULL OKit_Object was passed as argument



Function OKit_ObjectStat

unsigned long OKit_ObjectStat(OKit_Object obj) ;
Prints an OKit_Object's statistics.


Args
_obj:OKit_Object to query


Returns
_-1:if a NULL OKit_Object was passed as argument
else 0.



Function OKit_ObjectOut

unsigned long OKit_ObjectOut(OKit_Object obj, char * out, unsigned long max) ;
Prints an OKit_Object into a character string.


Args
_obj:OKit_Object to print
_out:allocated output string (at least max+1 characters)
_max:max number of characters to print


Returns
_-1:if some error occurred
_ the maximum number of character needed to print completely the object if 'out' is NULL (max is ignored)
else the total number of characters printed


Errors
_EINVAL:if a NULL OKit_Object was passed as argument



Function OKit_ObjectEqual

unsigned char OKit_ObjectEqual(OKit_Object obj, OKit_Object objw) ;
Tests the equality between OKit_Objects.


Args
_obj:OKit_Object to test
_objw:reference OKit_Object


Returns
_-1:if a NULL OKit_Object was passed as argument
_ 0:if the two OKit_Objects were distinct
_+1:if the two OKit_Objects were equal


Errors
_EINVAL:if a NULL OKit_Object was passed as argument



Function OKit_ObjectOKit_Strg

OKit_Strg OKit_ObjectOKit_Strg(OKit_Object obj) ;
Returns the String representation of an OKit_Object.


Args
_obj:OKit_Object to print


Returns
_NULL:if a NULL OKit_Object was passed as argument, or no memory was available
else the OKit_Object's String representation.


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available

Below this line, the methods specifications are incomplete.
You must read the source to know the exact behaviour of each function.





OKit_Void object type






Function OKit_VoidNew

OKit_Void OKit_VoidNew() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_VoidWrap

OKit_Object OKit_VoidWrap(OKit_Void vd) ;


Args
_vd:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_VoidOut

unsigned long OKit_VoidOut(OKit_Void vd, char * out, unsigned long max) ;


Args
_vd:
_out:
_max:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available




OKit_Intg object type






Function OKit_IntgAlloc

OKit_Intg OKit_IntgAlloc() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_IntgCopy

OKit_Intg OKit_IntgCopy(OKit_Intg in) ;


Args
_in:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_IntgClone

OKit_Intg OKit_IntgClone(OKit_Intg in) ;


Args
_in:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_IntgNew

OKit_Intg OKit_IntgNew(long nb) ;


Args
_nb:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_IntgWrap

OKit_Object OKit_IntgWrap(OKit_Intg in) ;


Args
_in:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_IntgOut

unsigned long OKit_IntgOut(OKit_Intg in, char * out, unsigned long max) ;


Args
_in:
_out:
_max:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_IntgEqual

unsigned char OKit_IntgEqual(OKit_Intg in, OKit_Intg inw) ;


Args
_in:
_inw:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available




OKit_Fltp object type






Function OKit_FltpAlloc

OKit_Fltp OKit_FltpAlloc() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_FltpCopy

OKit_Fltp OKit_FltpCopy(OKit_Fltp fp) ;


Args
_fp:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_FltpClone

OKit_Fltp OKit_FltpClone(OKit_Fltp fp) ;


Args
_fp:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_FltpNew

OKit_Fltp OKit_FltpNew(double nb) ;


Args
_nb:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_FltpWrap

OKit_Object OKit_FltpWrap(OKit_Fltp fp) ;


Args
_fp:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_FltpOut

unsigned long OKit_FltpOut(OKit_Fltp fp, char * out, unsigned long max) ;


Args
_fp:
_out:
_max:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_FltpEqual

unsigned char OKit_FltpEqual(OKit_Fltp fp, OKit_Fltp fpw) ;


Args
_fp:
_fpw:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgAlloc

OKit_Strg OKit_StrgAlloc(unsigned long size) ;


Args
_size:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgCopy

OKit_Strg OKit_StrgCopy(OKit_Strg str) ;


Args
_str:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgClone

OKit_Strg OKit_StrgClone(OKit_Strg str) ;


Args
_str:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgFree

void OKit_StrgFree(OKit_Strg str) ;


Args
_str:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgNew

OKit_Strg OKit_StrgNew(char * str) ;


Args
_str:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgWrap

OKit_Object OKit_StrgWrap(OKit_Strg str) ;


Args
_str:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgLen

unsigned long OKit_StrgLen(OKit_Strg str) ;


Args
_str:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgCat

OKit_Strg OKit_StrgCat(OKit_Strg str1, OKit_Strg str2) ;


Args
_str1:
_str2:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgCut

OKit_Strg OKit_StrgCut(OKit_Strg str, unsigned long beg, unsigned long end) ;


Args
_str:
_beg:
_end:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgOut

unsigned long OKit_StrgOut(OKit_Strg str, char * out, unsigned long max) ;


Args
_str:
_out:
_max:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgEqual

unsigned char OKit_StrgEqual(OKit_Strg str, OKit_Strg strw) ;


Args
_str:
_strw:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_StrgCharString

unsigned long OKit_StrgCharString(OKit_Strg str, char * out, unsigned long max) ;


Args
_str:
_out:
_max:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListAlloc

OKit_List OKit_ListAlloc() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListAllocBlock

OKit_List OKit_ListAllocBlock(unsigned long numb) ;


Args
_numb:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListCopy

OKit_List OKit_ListCopy(OKit_List lst) ;


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListClone

OKit_List OKit_ListClone(OKit_List lst) ;


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListDup

OKit_List OKit_ListDup(OKit_List lst) ;


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListDrop

OKit_List OKit_ListDrop(OKit_List lst) ;


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListFree

void OKit_ListFree(OKit_List lst) ;


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListNew

OKit_List OKit_ListNew() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListWrap

OKit_Object OKit_ListWrap(OKit_List lst) ;


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListLen

unsigned long OKit_ListLen(OKit_List lst) ;
Returns the length of a OKit_List.


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListGet

OKit_Object OKit_ListGet(OKit_List lst, unsigned long pos) ;
Gets an object by its position in a OKit_List.


Args
_lst:
_pos:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListPut

OKit_Object OKit_ListPut(OKit_List lst, unsigned long pos, OKit_Object obj) ;
Puts an object by its position in a OKit_List.


Args
_lst:
_pos:
_obj:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListDel

OKit_List OKit_ListDel(OKit_List lst, unsigned long beg, unsigned long end) ;
Deletes the objects in positions [beg,end[ in a OKit_List.


Args
_lst:
_beg:
_end:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListIns

OKit_List OKit_ListIns(OKit_List lst, unsigned long pos, OKit_List lsi) ;
Inserts the objects of the second OKit_List in the first, between the pos-1-th and the pos-th objects.


Args
_lst:
_pos:
_lsi:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available


Note
To prevent internal structures and memory corruption, lsi is empty after successfull
insertion.



Function OKit_ListPush

OKit_List OKit_ListPush(OKit_List lst, OKit_Object obj) ;
Adds an object at the end of a OKit_List.


Args
_lst:
_obj:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListPop

OKit_Object OKit_ListPop(OKit_List lst) ;
Retrives an object at the end of a OKit_List.


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListUnshift

OKit_List OKit_ListUnshift(OKit_List lst, OKit_Object obj) ;
Adds an object at the beginning of a OKit_List.


Args
_lst:
_obj:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListShift

OKit_Object OKit_ListShift(OKit_List lst) ;
Retrives an object at the beginning of a OKit_List.


Args
_lst:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListRail

unsigned long OKit_ListRail(OKit_List lst, unsigned long (* doit)(OKit_Object, unsigned long, void *), void * data) ;
Executes a function on all objects of a OKit_List, totalizing the return values.


Returns
_-1:if some error occured


Errors
_EINVAL:if a NULL OKit_List was passed as argument



Function OKit_ListSort

OKit_List OKit_ListSort(OKit_List lst, char (* cmp)(OKit_Object, OKit_Object)) ;
Sorts a OKit_List, using the provided OKit_Object comparison function


Returns
_NULL:if some error occured


Errors
_EINVAL:if a NULL OKit_List was passed as argument



Function OKit_ListOut

unsigned long OKit_ListOut(OKit_List lst, char * out, unsigned long max) ;


Args
_lst:
_out:
_max:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_ListEqual

unsigned char OKit_ListEqual(OKit_List lst, OKit_List lstw) ;


Args
_lst:
_lstw:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeAlloc

OKit_Code OKit_CodeAlloc() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeCopy

OKit_Code OKit_CodeCopy(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeClone

OKit_Code OKit_CodeClone(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeDup

OKit_Code OKit_CodeDup(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeDrop

OKit_Code OKit_CodeDrop(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeFree

void OKit_CodeFree(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeNew

OKit_Code OKit_CodeNew() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeWrap

OKit_Object OKit_CodeWrap(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeArgC

unsigned char OKit_CodeArgC(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeArgT

unsigned short OKit_CodeArgT(OKit_Code cod, unsigned char argn) ;


Args
_cod:
_argn:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeRetC

unsigned char OKit_CodeRetC(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeSetArgC

unsigned char OKit_CodeSetArgC(OKit_Code cod, unsigned char argc) ;


Args
_cod:
_argc:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeSetArgT

unsigned short OKit_CodeSetArgT(OKit_Code cod, unsigned char argn, OKit_Type argt) ;


Args
_cod:
_argn:
_argt:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeSetArgT

unsigned char OKit_CodeSetArgC(OKit_Code cod, unsigned char retc) ;


Args
_cod:
_retc:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeName

char * OKit_CodeName(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeOKit_StrgName

OKit_Strg OKit_CodeOKit_StrgName(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeGetFunc

void * OKit_CodeGetFunc(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeGetData

OKit_Object OKit_CodeGetData(OKit_Code cod) ;


Args
_cod:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeSetFunc

void * OKit_CodeSetFunc(OKit_Code cod, void * func) ;


Args
_cod:
_func:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeSetData

OKit_Object OKit_CodeSetData(OKit_Code cod, OKit_Object data) ;


Args
_cod:
_data:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeOut

unsigned long OKit_CodeOut(OKit_Code cod, char * out, unsigned long max) ;


Args
_cod:
_out:
_max:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_CodeEqual

unsigned char OKit_CodeEqual(OKit_Code cod, OKit_Code codw) ;


Args
_cod:
_codw:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnAlloc

OKit_Bltn OKit_BltnAlloc() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnCopy

OKit_Bltn OKit_BltnCopy(OKit_Bltn blt) ;


Args
_blt:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnClone

OKit_Bltn OKit_BltnClone(OKit_Bltn blt) ;


Args
_blt:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnFree

void OKit_BltnFree(OKit_Bltn blt) ;


Args
_blt:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnNew

OKit_Bltn OKit_BltnNew() ;


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnWrap

OKit_Object OKit_BltnWrap(OKit_Bltn blt) ;


Args
_blt:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnArgC

unsigned char OKit_BltnArgC(OKit_Bltn blt) ;


Args
_blt:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnArgT

unsigned short OKit_BltnArgT(OKit_Bltn blt, unsigned char argn) ;


Args
_blt:
_argn:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnName

OKit_Strg OKit_BltnName(OKit_Bltn blt) ;


Args
_blt:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnFunc

void * OKit_BltnFunc(OKit_Bltn blt) ;


Args
_blt:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnOut

unsigned long OKit_BltnOut(OKit_Bltn blt, char * out, unsigned long max) ;


Args
_blt:
_out:
_max:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available



Function OKit_BltnEqual

unsigned char OKit_BltnEqual(OKit_Bltn blt, OKit_Bltn bltw) ;


Args
_blt:
_bltw:


Returns
_NULL:if no memory was available


Errors
_EINVAL:if a NULL was passed as argument
_ENOMEM:if no memory was available