xBase and Clipper language compatible compiler
PrevNext

CLIP-XML

Name

CLIP-XML -- 

Function

<cError>            xml_errorString(<parser>)
<nColumn>           xml_getCurrentColumnNumber(<parser>)
<nLine>             xml_getCurrentLineNumber(<parser>)
<cError>            xml_getErrorCode(<parser>)
                    xml_parse(<parser>,<cString>,<nLen>,<isFinal>)
<oParser>           xml_parserCreate([<encoding>])
                    xml_parserFree(<parser>)
                    xml_setCDataSectionHandler(<parser>,<fStart>,<fEnd>)
                    xml_setCharacterDataHandler(<parser>,<fText>)
                    xml_setCommentHandler(<parser>,<fComments>)
                    xml_setDefaultHandler(<parser>,<fText>)
                    xml_setElementHandler(<parser>,<fStart>,<fEnd>)
                    xml_setEndCDataSectionHandler(<parser>,<fEnd>)
                    xml_setEndElementHandler(<parser>,<fEnd>)
                    xml_setParamEntityParsing(<parser>,<mode>)
                    xml_setStartCDataSectionHandler(<parser>,<fStart>)
                    xml_setStartElementHandler(<parser>,<fStart>)
                    xml_setUserData(<parser>,<data>)
<Result>            xml_XPath(<context>,<path>)

Description

Function XML_ERRORSTRING() 

 xml_errorString(<parser>)	--> <cError>

<parser>

- Object created by function xml_ParserCreate().

Returns :

XML parse error description.

Example :

 ? xml_errorString( parser )

Function XML_GETCURRENTCOLUMNNUMBER() 

 xml_getCurrentColumnNumber(<parser>)	--> <nColumn>

<parser>

- Object created by function xml_ParserCreate().

Returns :

Current column number in parsed XML file.

Example :

 ? xml_getCurrentColumnNumber( parser )

Function XML_GETCURRENTLINENUMBER() 

 xml_getCurrentLineNumber(<parser>)	--> <nLine>

<parser>

- Object created by function xml_ParserCreate().

Returns :

Current line number in parsed XML file.

Example :

 ? xml_getCurrentLineNumber( parser )

Function XML_GETERRORCODE() 

 xml_getErrorCode(<parser>)	--> <cError>

<parser>

- Object created by function xml_ParserCreate().

Returns :

XML parse error code.

Example :

 ? xml_getErrorCode( parser )

Function XML_PARSE() 

 xml_parse(<parser>,<cString>,<nLen>,<isFinal>)

<parser>

- Object created by function xml_ParserCreate().

<cString>

- String. Buffer with string from XML file.

<nLen>

- Number. Length of string.

<isFinal>

- Boolean. Flag for end XML stream.

Returns :

NIL

Example :

 parser := xml_ParserCreate()
 
 xml_SetElementHandler( parser, @myStartElement(), @myEndElement() )
 xml_Parse( parser, string, len( string ), .T. )
 
 if xml_GetErrorCode( parser ) <> 0
 ? xml_ErrorString( parser ) + ;
 " at line "+alltrim( str( xml_GetCurrentLineNumber( parser ) ) ) + ;
 ", column "+alltrim( str( xml_GetCurrentColumnNumber( parser ) ) )
 endif
 xml_parserFree( parser )

Function XML_PARSERCREATE() 

 xml_parserCreate([<encoding>])	--> <oParser>

<encoding>

- String. XML encoding.

Returns :

Parser object.

Example :

 xml_parserCreate()

Function XML_PARSERFREE() 

 xml_parserFree(<parser>)

<parser>

- Object created by function xml_ParserCreate().

Returns :

NIL

Example :

 xml_parserFree( parser )

Function XML_SETCDATASECTIONHANDLER() 

 xml_setCDataSectionHandler(<parser>,<fStart>,<fEnd>)

<parser>

- Object created by function xml_ParserCreate().

<fStart>

- Function or code block. Handle function for start of CDATA block. Passed parameters: <userData> - user data.

<fEnd>

- Function or code block. Handle function for end of CDATA block. Passed parameters: <userData> - user data.

Returns :

NIL

Example :

 xml_setCDataSectionHandler( parser, @myStartCData(), @myEndCData() )

Function XML_SETCHARACTERDATAHANDLER() 

 xml_setCharacterDataHandler(<parser>,<fText>)

<parser>

- Object created by function xml_ParserCreate().

<fText>

- Function or code block. Handle function for text block. Passed parameters: <userData> - user data, <cStr> - text, <nLen> - text length.

Returns :

NIL

Example :

 xml_setCharacterDataHandler( parser, @myText() )

Function XML_SETCOMMENTHANDLER() 

 xml_setCommentHandler(<parser>,<fComments>)

<parser>

- Object created by function xml_ParserCreate().

<fComments>

- Function or code block. Handle function for comments. Passed parameters: <userData> - user data, <cStr> - comment text.

Returns :

NIL

Example :

 xml_setCommentHandler( parser, @myComments() )

Function XML_SETDEFAULTHANDLER() 

 xml_setDefaultHandler(<parser>,<fText>)

<parser>

- Object created by function xml_ParserCreate().

<fText>

- Function or code block. Handle function for text which wouldn't otherwise be handled. Passed parameters: <userData> - user data, <cStr> - text, <nLen> - text length.

Returns :

NIL

Example :

 xml_setDefaultHandler( parser, @myOtherText() )

Function XML_SETELEMENTHANDLER() 

 xml_setElementHandler(<parser>,<fStart>,<fEnd>)

<parser>

- Object created by function xml_ParserCreate().

<fStart>

- Function or code block. Handle function for start tag. Passed parameters: <userData> - user data, <cName> - tag name, <aAttrs> - array of pair attribute name and its value.

<fEnd>

- Function or code block. Handle function for end tag. Passed parameters: <userData> - user data, <cName> - tag name.

Returns :

NIL

Example :

 xml_setElementHandler( parser, @myStartElement(), @myEndElement() )

Function XML_SETENDCDATASECTIONHANDLER() 

 xml_setEndCDataSectionHandler(<parser>,<fEnd>)

<parser>

- Object created by function xml_ParserCreate().

<fEnd>

- Function or code block. Handle function for end of CDATA block. Passed parameters: <userData> - user data.

Returns :

NIL

Example :

 xml_setEndCDataSectionHandler( parser, @myEndCData() )

Function XML_SETENDELEMENTHANDLER() 

 xml_setEndElementHandler(<parser>,<fEnd>)

<parser>

- Object created by function xml_ParserCreate().

<fEnd>

- Function or code block. Handle function for end tag. Passed parameters: <userData> - user data, <cName> - tag name.

Returns :

NIL

Example :

 xml_setEndElementHandler( parser, @myEndElement() )

Function XML_SETPARAMENTITYPARSING() 

 xml_setParamEntityParsing(<parser>,<mode>)

<parser>

- Object created by function xml_ParserCreate().

<mode>

- Number. This enables parsing of parameter entities, including the external parameter entity that is the external DTD subset, according to <mode>. Include clip-expat.ch and see Expat documentation.

Returns :

NIL

Example :

 xml_setParamEntityParsing( parser, XML_PARAM_ENTITY_PARSING_NEVER )

Function XML_SETSTARTCDATASECTIONHANDLER() 

 xml_setStartCDataSectionHandler(<parser>,<fStart>)

<parser>

- Object created by function xml_ParserCreate().

<fStart>

- Function or code block. Handle function for start of CDATA block. Passed parameters: <userData> - user data.

Returns :

NIL

Example :

 xml_setStartCDataSectionHandler( parser, @myStartCData() )

Function XML_SETSTARTELEMENTHANDLER() 

 xml_setStartElementHandler(<parser>,<fStart>)

<parser>

- Object created by function xml_ParserCreate().

<fStart>

- Function or code block. Handle function for start tag. Passed parameters: <userData> - user data, <cName> - tag name, <aAttrs> - array of pair attribute name and its value.

Returns :

NIL

Example :

 xml_setStartElementHandler( parser, @myStartElement() )

Function XML_SETUSERDATA() 

 xml_setUserData(<parser>,<data>)

<parser>

- Object created by function xml_ParserCreate().

<data>

- Any type. User data for parser.

Returns :

NIL

Example :

 xml_setUserData( parser, { "user data" } )

Function XML_XPATH() 

 xml_XPath(<context>,<path>)	--> <Result>

<context>

- XMLTag object. Context tag.

<path>

- String. XPath query.

Returns :

XPath query result.

Example :

 f := XMLTree()
 f:parseFile( "component.xml" )
 aRes := xml_XPath( f:getRoot(), "/requires/*" )

PrevHomeNext
GAMEUpTERMINAL/IO