Scol functions definition

Functions
int	_CreateXml (mmachine m)
	_CreateXml : This function create an empty ObjSXML object
int	_OpenXml (mmachine m)
	_OpenXml : This function create an ObjSXML object from a file
int	_OpenXmlS (mmachine m)
	_OpenXmlS : This function create an ObjSXML object from a string
int	_SaveXml (mmachine m)
	_SaveXml : This function save an ObjSXML object to a file
int	_DestroyXml (mmachine m)
	_DestroyXml : This function destroy an ObjSXML object
int	_GetXmlRootNodes (mmachine m)
	_GetXmlRootNodes : This function retrieve the root nodes of an ObjSXML object
int	_GetXmlNodeChilds (mmachine m)
	_GetXmlNodeChilds : This function retrieve the child nodes of an ObjSXMLNode object
int	_GetXmlNodeValue (mmachine m)
	_GetXmlNodeValue : This function retrieve the value of an ObjSXMLNode object
int	_SetXmlNodeValue (mmachine m)
	_SetXmlNodeValue : This function set the value of an ObjSXMLNode object
int	_GetXmlNodeContent (mmachine m)
	_GetXmlNodeContent : This function retrieve the content of an ObjSXMLNode object
int	_SetXmlNodeContent (mmachine m)
	_SetXmlNodeContent : This function set the content of an ObjSXMLNode object
int	_GetXmlNodeAttributes (mmachine m)
	_GetXmlNodeAttributes : This function retrieve the attrtibutes of an ObjSXMLNode object
int	_SetXmlNodeAttributes (mmachine m)
	_SetXmlNodeAttributes : This function set the attrtibutes of an ObjSXMLNode object
int	_RemoveXmlNode (mmachine m)
	_RemoveXmlNode : This function remove an ObjSXMLNode
int	_AddXmlRootNode (mmachine m)
	_AddXmlRootNode : This function adds a root ObjSXMLNode
int	_AddXmlNode (mmachine m)
	_AddXmlNode : This function add an ObjSXMLNode
int	_GetXmlContent (mmachine m)
	_GetXmlContent : This function return an ObjSXML object content

Detailed Description

Scol functions definition

Function Documentation

_AddXmlNode()

int _AddXmlNode

(

mmachine

m

)

_AddXmlNode : This function add an ObjSXMLNode

Prototype: fun [ObjSXMLNode S] ObjSXMLNode

Parameters

ObjSXMLNode	: parent ObjSXMLNode object
S	: new node value

Returns

ObjSXMLNode : the new node on success, NIL otherwise

Definition at line 993 of file sXml.cpp.

_AddXmlRootNode()

int _AddXmlRootNode

(

mmachine

m

)

_AddXmlRootNode : This function adds a root ObjSXMLNode

Prototype: fun [ObjSXML S] ObjSXMLNode

Parameters

ObjSXMLNode	: the ObjSXMLNode object
S	: the new value to add

Returns

ObjSXMLNode : the new node on success, NIL otherwise

Definition at line 945 of file sXml.cpp.

_CreateXml()

int _CreateXml

(

mmachine

m

)

_CreateXml : This function create an empty ObjSXML object

Prototype: fun [Chn] ObjSXML

Parameters

Chn	: the current channel

Returns

ObjSXML : The ObjSXML object or NIL if creation fails

Definition at line 163 of file sXml.cpp.

_DestroyXml()

int _DestroyXml

(

mmachine

m

)

_DestroyXml : This function destroy an ObjSXML object

Prototype: fun [ObjSXML] I

Parameters

ObjSXML	: the ObjSXML object to destroy
S	: the xml content

Returns

I : 0 on success, NIL otherwise

Definition at line 386 of file sXml.cpp.

_GetXmlContent()

int _GetXmlContent

(

mmachine

m

)

_GetXmlContent : This function return an ObjSXML object content

Prototype: fun [ObjSXML] S

Parameters

ObjSXML

: the Xml object

Returns

S : the content on success, NIL on fails

Definition at line 1048 of file sXml.cpp.

_GetXmlNodeAttributes()

int _GetXmlNodeAttributes

(

mmachine

m

)

_GetXmlNodeAttributes : This function retrieve the attrtibutes of an ObjSXMLNode object

Prototype: fun [ObjSXMLNode] [[S S] r1]

Parameters

ObjSXMLNode

: the ObjSXMLNode object

Returns

[S S] r1 : The attributes of the nodes, NIL otherwise

Definition at line 757 of file sXml.cpp.

_GetXmlNodeChilds()

int _GetXmlNodeChilds

(

mmachine

m

)

_GetXmlNodeChilds : This function retrieve the child nodes of an ObjSXMLNode object

Prototype: fun [ObjSXMLNode] [ObjSXMLNode r1]

Parameters

ObjSXMLNode

: the ObjSXMLNode object

Returns

[ObjSXMLNode r1] : The list of child nodes, NIL otherwise

Definition at line 487 of file sXml.cpp.

_GetXmlNodeContent()

int _GetXmlNodeContent

(

mmachine

m

)

_GetXmlNodeContent : This function retrieve the content of an ObjSXMLNode object

Prototype: fun [ObjSXMLNode] S

Parameters

ObjSXMLNode

: the ObjSXMLNode object

Returns

S : The content of the nodes, NIL otherwise

Definition at line 634 of file sXml.cpp.

_GetXmlNodeValue()

int _GetXmlNodeValue

(

mmachine

m

)

_GetXmlNodeValue : This function retrieve the value of an ObjSXMLNode object

Prototype: fun [ObjSXMLNode] S

Parameters

ObjSXMLNode

: the ObjSXMLNode object

Returns

S : The value of the nodes, NIL otherwise

Definition at line 564 of file sXml.cpp.

_GetXmlRootNodes()

int _GetXmlRootNodes

(

mmachine

m

)

_GetXmlRootNodes : This function retrieve the root nodes of an ObjSXML object

Prototype: fun [ObjSXML] [ObjSXMLNode r1]

Parameters

ObjSXML

: the ObjSXML object

Returns

[ObjSXMLNode r1] : The list of root nodes, NIL otherwise

Definition at line 418 of file sXml.cpp.

_OpenXml()

int _OpenXml

(

mmachine

m

)

_OpenXml : This function create an ObjSXML object from a file

Prototype: fun [Chn P] ObjSXML

Parameters

Chn	: the current channel
P	: the xml file

Returns

ObjSXML : The ObjSXML object or NIL if creation fails

Definition at line 211 of file sXml.cpp.

_OpenXmlS()

int _OpenXmlS

(

mmachine

m

)

_OpenXmlS : This function create an ObjSXML object from a string

Prototype: fun [Chn S] ObjSXML

Parameters

Chn	: the current channel
S	: the xml content

Returns

ObjSXML : The ObjSXML object or NIL if creation fails

Definition at line 281 of file sXml.cpp.

_RemoveXmlNode()

int _RemoveXmlNode

(

mmachine

m

)

_RemoveXmlNode : This function remove an ObjSXMLNode

Prototype: fun [ObjSXMLNode] I

Parameters

ObjSXMLNode

: the ObjSXMLNode object

Returns

I : 1 on success, NIL otherwise

Definition at line 898 of file sXml.cpp.

_SaveXml()

int _SaveXml

(

mmachine

m

)

_SaveXml : This function save an ObjSXML object to a file

Prototype: fun [ObjSXML W] I

Parameters

ObjSXML	: the Xml object
W	: the file to write

Returns

I : 1 on success, NIL on fails

Definition at line 342 of file sXml.cpp.

_SetXmlNodeAttributes()

int _SetXmlNodeAttributes

(

mmachine

m

)

_SetXmlNodeAttributes : This function set the attrtibutes of an ObjSXMLNode object

Prototype: fun [ObjSXMLNode [[S S] r1]] ObjSXMLNode

Parameters

ObjSXMLNode	: the ObjSXMLNode object
[[S	S] r1] : the list of attributes [name value]

Returns

ObjSXMLNode : The same ObjSXMLNode on success, NIL otherwise

Definition at line 823 of file sXml.cpp.

_SetXmlNodeContent()

int _SetXmlNodeContent

(

mmachine

m

)

_SetXmlNodeContent : This function set the content of an ObjSXMLNode object

Prototype: fun [ObjSXMLNode S] ObjSXMLNode

Parameters

ObjSXMLNode	: the ObjSXMLNode object
S	: the new content

Returns

ObjSXMLNode : The same ObjSXMLNode on success, NIL otherwise

Definition at line 684 of file sXml.cpp.

_SetXmlNodeValue()

int _SetXmlNodeValue

(

mmachine

m

)

_SetXmlNodeValue : This function set the value of an ObjSXMLNode object

Prototype: fun [ObjSXMLNode S] ObjSXMLNode

Parameters

ObjSXMLNode	: the ObjSXMLNode object
S	: the new value

Returns

ObjSXMLNode : The same ObjSXMLNode on success, NIL otherwise

Definition at line 598 of file sXml.cpp.