XML low-level C encode/decode functions. More...

#include "rtxsrc/rtxCommon.h"
#include "rtxmlsrc/rtSaxDefs.h"
#include "rtxsrc/rtxDList.h"
#include "rtxsrc/rtxMemBuf.h"
#include "rtxmlsrc/rtXmlExternDefs.h"
#include "rtxmlsrc/rtXmlErrCodes.h"
#include "rtxmlsrc/rtXmlNamespace.h"

Classes
struct	OSXMLFacets

struct	OSXMLStrFragment

struct	OSXMLNameFragments

struct	OSXMLItemDescr

struct	OSXMLElemIDRec

struct	OSXMLGroupDesc
	OSXMLGroupDesc describes how entries in an OSXMLElemIDRec array make up a group. More...

struct	OSXSDAnyType

struct	OSXMLCtxtInfo

struct	OSXMLQName

struct	OSIntegerFmt

struct	OSXMLSortedAttrOffset

Macros
#define	OSXMLNS12

#define	OSUPCASE 0x00008000 /* convert characters to upper case */

#define	OSTERMSTART 0x00004000 /* term for start elem (>) needed */

#define	OSEMPTYELEM 0x00002000 /* element is empty (no content) */

#define	OSQUALATTR 0x00001000 /* qualified attribute */

#define	OSXMLFRAG 0x00000800 /* XML fragment (not full doc) */

#define	OSXMLNSSET 0x00000400 /* Indicates namespaces are set */

#define	OSXMLC14N

#define	OSXSIATTR 0x00000100 /* add xsi ns decl to encoded msg */

#define	OSXMLNOCMPNS 0x00000080 /* match local names only */

#define	OSXSINIL 0x00000040 /* add xsi:nil decl to encoded msg */

#define	OSHASDEFAULT

#define	OSASN1XER

#define	OSXMLFRAGSEQUAL(frag1, frag2) (frag1.length==frag2.length && !memcmp(frag1.value,frag2.value,frag1.length))

#define	OSXMLQNAMEEQUALS(xnamefrag, qnametext)

#define	OSXMLSETUTF8DECPTR(pctxt, str)

#define	IS_XMLNSATTR(name)

#define	IS_XSIATTR(name)

#define	OSXMLINDENT 3

#define	rtXmlErrAddStrParm rtxErrAddStrParm

#define	rtxPrintNSAttrs(name, data) rtXmlPrintNSAttrs(name,&data)

#define	rtXmlFinalizeMemBuf(pMemBuf)

#define	rtXmlGetEncBufPtr(pctxt) (pctxt)->buffer.data
	This macro returns the start address of the encoded XML message. More...

#define	rtXmlGetEncBufLen(pctxt) (pctxt)->buffer.byteIndex
	This macro returns the length of the encoded XML message. More...

#define	OSXMLREALENC_OBJSYS 0x1F /* Obj-Sys XML encoding rules */

#define	OSXMLREALENC_BXER 0x10 /* basic-XER */

#define	OSXMLREALENC_EXERMODS 0x1B /* extended-XER with MODIFIED-ENCODINGS */

#define	OSXMLREALENC_EXERDECIMAL 0x03 /* extended-XER with DECIMAL */

Typedefs
typedef struct OSXMLFacets	OSXMLFacets

typedef struct OSXMLItemDescr	OSXMLItemDescr

typedef OSXMLItemDescr	OSXMLAttrDescr

typedef OSXMLItemDescr	OSXMLElemDescr

typedef struct OSXMLElemIDRec	OSXMLElemIDRec

typedef struct OSXMLGroupDesc	OSXMLGroupDesc
	OSXMLGroupDesc describes how entries in an OSXMLElemIDRec array make up a group. More...

typedef struct OSXSDAnyType	OSXSDAnyType

typedef struct OSXMLQName	OSXMLQName

typedef struct OSIntegerFmt	OSIntegerFmt

Enumerations
enum	OSXMLEncoding { OSXMLUTF8, OSXMLUTF16, OSXMLUTF16BE, OSXMLUTF16LE, OSXMLLATIN1 }

enum	OSXMLSOAPMsgType { OSSOAPNONE, OSSOAPHEADER, OSSOAPBODY, OSSOAPFAULT }

enum	OSXMLBOM { OSXMLBOM_NO_BOM, OSXMLBOM_UTF32_BE, OSXMLBOM_UTF32_LE, OSXMLBOM_UTF16_BE, OSXMLBOM_UTF16_LE, OSXMLBOM_UTF8, OSXMLBOM_CHECK }

enum	OSXMLNsIndex { OSXMLNSI_UNQUALIFIED = 0, OSXMLNSI_UNKNOWN = -1, OSXMLNSI_UNCHECKED = -2, OSXMLNSI_XSI = -3, OSXMLNSI_XMLNS = -4, OSXMLNSI_XML = -5, OSXMLNSI_SOAP_ENVELOPE = -6, OSXMLNSI_XSD = -7 }

enum	OSXMLREALEncoding { OSXMLREALOBJSYS, OSXMLREALBXER, OSXMLREALEXERMODS, OSXMLREALEXERDEC }

enum	OSXMLState { OSXMLINIT, OSXMLHEADER, OSXMLSTART, OSXMLATTR, OSXMLDATA, OSXMLEND, OSXMLCOMMENT }

enum	OSXMLWhiteSpaceMode { OSXMLWSM_PRESERVE = 0, OSXMLWSM_REPLACE, OSXMLWSM_COLLAPSE }
	Whitespace treatment options.

Functions
EXTERNXML int	rtXmlInitContext (OSCTXT *pctxt)
	This function initializes a context variable for XML encoding or decoding. More...

EXTERNXML int	rtXmlInitContextUsingKey (OSCTXT pctxt, const OSOCTET key, OSSIZE keylen)
	This function initializes a context using a run-time key. More...

EXTERNXML int	rtXmlInitCtxtAppInfo (OSCTXT *pctxt)
	This function initializes the XML application info section of the given context. More...

EXTERNXML int	rtXmlCreateFileInputSource (OSCTXT pctxt, const char filepath)
	This function creates an XML document file input source. More...

EXTERNXML OSBOOL	rtXmlCmpQName (const OSUTF8CHAR qname1, const OSUTF8CHAR name2, const OSUTF8CHAR *nsPrefix2)

EXTERNXML int	rtXmlGetBase64StrDecodedLen (const OSUTF8CHAR inpdata, OSSIZE srcDataSize, OSSIZE pNumOcts, OSSIZE *pSrcDataLen)

EXTERNXML void	rtXmlMemFreeAnyAttrs (OSCTXT pctxt, OSRTDList pAnyAttrList)
	This function frees a list of anyAttribute that is a member of OSXSDAnyType structure. More...

EXTERNXML int	rtXmlDecBase64Binary (OSRTMEMBUF pMemBuf, const OSUTF8CHAR inpdata, OSSIZE length)
	This function decodes the contents of a Base64-encoded binary data type into a memory buffer. More...

EXTERNXML int	rtXmlDecBase64Str (OSCTXT pctxt, OSOCTET pvalue, OSUINT32 *pnocts, OSINT32 bufsize)
	This function decodes a contents of a Base64-encode binary string into a static memory structure. More...

EXTERNXML int	rtXmlDecBase64Str64 (OSCTXT pctxt, OSOCTET pvalue, OSSIZE *pnocts, OSSIZE bufsize)
	This function is identical to rtXmlDecBase64Str except that is supports a 64-bit integer length on 64-bit systems. More...

EXTERNXML int	rtXmlDecBase64StrValue (OSCTXT pctxt, OSOCTET pvalue, OSUINT32 *pnocts, OSSIZE bufSize, OSSIZE srcDataLen)
	This function decodes a contents of a Base64-encode binary string into the specified octet array. More...

EXTERNXML int	rtXmlDecBase64StrValue64 (OSCTXT pctxt, OSOCTET pvalue, OSSIZE *pnocts, OSSIZE bufSize, OSSIZE srcDataLen)
	This function decodes is identical to rtXmlDecBase64StrValue except that it supports a 64-bit integer length on 64-bit systems. More...

EXTERNXML int	rtXmlDecBigInt (OSCTXT pctxt, const OSUTF8CHAR *ppvalue)
	This function will decode a variable of the XSD integer type. More...

EXTERNXML int	rtXmlDecBool (OSCTXT pctxt, OSBOOL pvalue)
	This function decodes a variable of the boolean type. More...

EXTERNXML int	rtXmlDecDate (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'date' type. More...

EXTERNXML int	rtXmlDecTime (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'time' type. More...

EXTERNXML int	rtXmlDecDateTime (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'dateTime' type. More...

EXTERNXML int	rtXmlDecDecimal (OSCTXT pctxt, OSREAL pvalue)
	This function decodes the contents of a decimal data type. More...

EXTERNXML int	rtXmlDecDouble (OSCTXT pctxt, OSREAL pvalue)
	This function decodes the contents of a float or double data type. More...

EXTERNXML int	rtXmlDecDynBase64Str (OSCTXT pctxt, OSDynOctStr pvalue)
	This function decodes a contents of a Base64-encode binary string. More...

EXTERNXML int	rtXmlDecDynBase64Str64 (OSCTXT pctxt, OSDynOctStr64 pvalue)
	This function is identical to rtXmlDecDynBase64Str except that it supports a 64-bit integer length on 64-bit systems. More...

EXTERNXML int	rtXmlDecDynHexStr (OSCTXT pctxt, OSDynOctStr pvalue)
	This function decodes a contents of a hexBinary string. More...

EXTERNXML int	rtXmlDecDynHexStr64 (OSCTXT pctxt, OSDynOctStr64 pvalue)
	This function is identical to rtXmlDecDynHexStr except that it supports a 64-bit integer length on 64-bit systems. More...

EXTERNXML int	rtXmlDecEmptyElement (OSCTXT *pctxt)
	This function is used to enforce a requirement that an element be empty. More...

EXTERNXML int	rtXmlDecUTF8Str (OSCTXT pctxt, OSUTF8CHAR outdata, OSSIZE max_len)
	This function decodes the contents of a UTF-8 string data type. More...

EXTERNXML int	rtXmlDecDynUTF8Str (OSCTXT pctxt, const OSUTF8CHAR *outdata)
	This function decodes the contents of a UTF-8 string data type. More...

EXTERNXML int	rtXmlDecHexBinary (OSRTMEMBUF pMemBuf, const OSUTF8CHAR inpdata, OSSIZE length)
	This function decodes the contents of a hex-encoded binary data type into a memory buffer. More...

EXTERNXML int	rtXmlDecHexStr (OSCTXT pctxt, OSOCTET pvalue, OSUINT32 *pnocts, OSINT32 bufsize)
	This function decodes the contents of a hexBinary string into a static memory structure. More...

EXTERNXML int	rtXmlDecHexStr64 (OSCTXT pctxt, OSOCTET pvalue, OSSIZE *pnocts, OSSIZE bufsize)
	This function is identical to rtXmlDecHexStr except that it supports a 64-bit integer length on 64-bit systems. More...

EXTERNXML int	rtXmlDecHexStrValue (OSCTXT pctxt, const OSUTF8CHAR const inpdata, OSSIZE nbytes, OSOCTET pvalue, OSUINT32 pnbits, OSINT32 bufsize)

EXTERNXML int	rtXmlDecHexStrValue64 (OSCTXT pctxt, const OSUTF8CHAR const inpdata, OSSIZE nbytes, OSOCTET pvalue, OSSIZE pnbits, OSSIZE bufsize)

EXTERNXML int	rtXmlDecGYear (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gYear' type. More...

EXTERNXML int	rtXmlDecGYearMonth (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gYearMonth' type. More...

EXTERNXML int	rtXmlDecGMonth (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gMonth' type. More...

EXTERNXML int	rtXmlDecGMonthDay (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gMonthDay' type. More...

EXTERNXML int	rtXmlDecGDay (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gDay' type. More...

EXTERNXML int	rtXmlDecInt (OSCTXT pctxt, OSINT32 pvalue)
	This function decodes the contents of a 32-bit integer data type. More...

EXTERNXML int	rtXmlDecInt8 (OSCTXT pctxt, OSINT8 pvalue)
	This function decodes the contents of an 8-bit integer data type (i.e. More...

EXTERNXML int	rtXmlDecInt16 (OSCTXT pctxt, OSINT16 pvalue)
	This function decodes the contents of a 16-bit integer data type. More...

EXTERNXML int	rtXmlDecInt64 (OSCTXT pctxt, OSINT64 pvalue)
	This function decodes the contents of a 64-bit integer data type. More...

EXTERNXML int	rtXmlDecUInt (OSCTXT pctxt, OSUINT32 pvalue)
	This function decodes the contents of an unsigned 32-bit integer data type. More...

EXTERNXML int	rtXmlDecUInt8 (OSCTXT pctxt, OSUINT8 pvalue)
	This function decodes the contents of an unsigned 8-bit integer data type (i.e. More...

EXTERNXML int	rtXmlDecUInt16 (OSCTXT pctxt, OSUINT16 pvalue)
	This function decodes the contents of an unsigned 16-bit integer data type. More...

EXTERNXML int	rtXmlDecUInt64 (OSCTXT pctxt, OSUINT64 pvalue)
	This function decodes the contents of an unsigned 64-bit integer data type. More...

EXTERNXML int	rtXmlDecNSAttr (OSCTXT pctxt, const OSUTF8CHAR attrName, const OSUTF8CHAR attrValue, OSRTDList pNSAttrs, const OSUTF8CHAR *nsTable[], OSUINT32 nsTableRowCount)
	This function decodes an XML namespac attribute (xmlns). More...

EXTERNXML const OSUTF8CHAR *	rtXmlDecQName (OSCTXT pctxt, const OSUTF8CHAR qname, const OSUTF8CHAR **prefix)
	This function decodes an XML qualified name string (QName) type. More...

EXTERNXML int	rtXmlDecXSIAttr (OSCTXT pctxt, const OSUTF8CHAR attrName, const OSUTF8CHAR *attrValue)
	This function decodes XML schema instance (XSI) attribute. More...

EXTERNXML int	rtXmlDecXSIAttrs (OSCTXT pctxt, const OSUTF8CHAR const attrs, const char typeName)
	This function decodes XML schema instance (XSI) attributes. More...

EXTERNXML int	rtXmlDecXmlStr (OSCTXT pctxt, OSXMLSTRING outdata)
	This function decodes the contents of an XML string data type. More...

EXTERNXML int	rtXmlParseElementName (OSCTXT pctxt, OSUTF8CHAR *ppName)
	This function parses the initial tag from an XML message. More...

EXTERNXML int	rtXmlParseElemQName (OSCTXT pctxt, OSXMLQName pQName)
	This function parses the initial tag from an XML message. More...

EXTERNXML int	rtXmlEncAny (OSCTXT pctxt, OSXMLSTRING pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the XSD any type. More...

EXTERNXML int	rtXmlEncAnyStr (OSCTXT pctxt, const OSUTF8CHAR pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)

EXTERNXML int	rtXmlEncAnyTypeValue (OSCTXT pctxt, const OSUTF8CHAR pvalue)
	This function encodes a variable of the XSD anyType type. More...

EXTERNXML int	rtXmlEncAnyAttr (OSCTXT pctxt, OSRTDList pAnyAttrList)
	This function encodes a list of OSAnyAttr attributes in which the name and value are given as a UTF-8 string. More...

EXTERNXML int	rtXmlEncBase64Binary (OSCTXT pctxt, OSSIZE nocts, const OSOCTET value, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the XSD base64Binary type. More...

EXTERNXML int	rtXmlEncBase64BinaryAttr (OSCTXT pctxt, OSUINT32 nocts, const OSOCTET value, const OSUTF8CHAR *attrName, OSSIZE attrNameLen)
	This function encodes a variable of the XSD base64Binary type as an attribute. More...

EXTERNXML int	rtXmlEncBase64StrValue (OSCTXT pctxt, OSSIZE nocts, const OSOCTET value)
	This function encodes a variable of the XSD base64Binary type. More...

EXTERNXML int	rtXmlEncBigInt (OSCTXT pctxt, const OSUTF8CHAR value, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the XSD integer type. More...

EXTERNXML int	rtXmlEncBigIntAttr (OSCTXT pctxt, const OSUTF8CHAR value, const OSUTF8CHAR *attrName, OSSIZE attrNameLen)
	This function encodes an XSD integer attribute value. More...

EXTERNXML int	rtXmlEncBigIntValue (OSCTXT pctxt, const OSUTF8CHAR value)
	This function encodes an XSD integer attribute value. More...

EXTERNXML int	rtXmlEncBitString (OSCTXT pctxt, OSSIZE nbits, const OSOCTET value, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the ASN.1 BIT STRING type. More...

EXTERNXML int	rtXmlEncBitStringExt (OSCTXT pctxt, OSSIZE nbits, const OSOCTET value, OSSIZE dataSize, const OSOCTET extValue, const OSUTF8CHAR elemName, OSXMLNamespace *pNS)
	This function encodes a variable of the ASN.1 BIT STRING type. More...

EXTERNXML int	rtXmlEncBinStrValue (OSCTXT pctxt, OSSIZE nbits, const OSOCTET data)
	This function encodes a binary string value as a sequence of '1's and '0's. More...

EXTERNXML int	rtXmlEncBool (OSCTXT pctxt, OSBOOL value, const OSUTF8CHAR elemName, OSXMLNamespace *pNS)
	This function encodes a variable of the XSD boolean type. More...

EXTERNXML int	rtXmlEncBoolValue (OSCTXT *pctxt, OSBOOL value)
	This function encodes a variable of the XSD boolean type. More...

EXTERNXML int	rtXmlEncBoolAttr (OSCTXT pctxt, OSBOOL value, const OSUTF8CHAR attrName, OSSIZE attrNameLen)
	This function encodes an XSD boolean attribute value. More...

EXTERNXML int	rtXmlEncCanonicalSort (OSCTXT pctxt, OSCTXT pBufCtxt, OSRTSList *pList)
	Sort (as for CXER, Canonical-XER) and encode previously encoded SET OF components. More...

EXTERNXML int	rtXmlEncComment (OSCTXT pctxt, const OSUTF8CHAR comment)
	This function encodes an XML comment. More...

EXTERNXML int	rtXmlEncDate (OSCTXT pctxt, const OSXSDDateTime pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the XSD 'date' type as a string. More...

EXTERNXML int	rtXmlEncDateValue (OSCTXT pctxt, const OSXSDDateTime pvalue)
	This function encodes a variable of the XSD 'date' type as a string. More...

EXTERNXML int	rtXmlEncTime (OSCTXT pctxt, const OSXSDDateTime pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the XSD 'time' type as an string. More...

EXTERNXML int	rtXmlEncTimeValue (OSCTXT pctxt, const OSXSDDateTime pvalue)
	This function encodes a variable of the XSD 'time' type as an string. More...

EXTERNXML int	rtXmlEncDateTime (OSCTXT pctxt, const OSXSDDateTime pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a numeric date/time value into an XML string representation. More...

EXTERNXML int	rtXmlEncDateTimeValue (OSCTXT pctxt, const OSXSDDateTime pvalue)
	This function encodes a numeric date/time value into an XML string representation. More...

EXTERNXML int	rtXmlEncDecimal (OSCTXT pctxt, OSREAL value, const OSUTF8CHAR elemName, OSXMLNamespace pNS, const OSDecimalFmt pFmtSpec)
	This function encodes a variable of the XSD decimal type. More...

EXTERNXML int	rtXmlEncDecimalAttr (OSCTXT pctxt, OSREAL value, const OSUTF8CHAR attrName, OSSIZE attrNameLen, const OSDecimalFmt *pFmtSpec)
	This function encodes a variable of the XSD decimal type as an attribute. More...

EXTERNXML int	rtXmlEncDecimalValue (OSCTXT pctxt, OSREAL value, const OSDecimalFmt pFmtSpec, char *pDestBuf, OSSIZE destBufSize)
	This function encodes a value of the XSD decimal type. More...

EXTERNXML int	rtXmlEncDouble (OSCTXT pctxt, OSREAL value, const OSUTF8CHAR elemName, OSXMLNamespace pNS, const OSDoubleFmt pFmtSpec)
	This function encodes a variable of the XSD double type. More...

EXTERNXML int	rtXmlEncDoubleAttr (OSCTXT pctxt, OSREAL value, const OSUTF8CHAR attrName, OSSIZE attrNameLen, const OSDoubleFmt *pFmtSpec)
	This function encodes a variable of the XSD double type as an attribute. More...

EXTERNXML int	rtXmlEncDoubleNormalValue (OSCTXT pctxt, OSREAL value, const OSDoubleFmt pFmtSpec, int defaultPrecision)
	This function encodes a normal (not +/-INF or NaN) value of the XSD double or float type. More...

EXTERNXML int	rtXmlEncDoubleValue (OSCTXT pctxt, OSREAL value, const OSDoubleFmt pFmtSpec, int defaultPrecision)
	This function encodes a value of the XSD double or float type. More...

EXTERNXML int	rtXmlEncEmptyElement (OSCTXT pctxt, const OSUTF8CHAR elemName, OSXMLNamespace pNS, OSRTDList pNSAttrs, OSBOOL terminate)
	This function encodes an enpty element tag value (<elemName/>). More...

EXTERNXML int	rtXmlEncEndDocument (OSCTXT *pctxt)
	This function adds trailor information and a null terminator at the end of the XML document being encoded. More...

EXTERNXML int	rtXmlEncEndElement (OSCTXT pctxt, const OSUTF8CHAR elemName, OSXMLNamespace *pNS)
	This function encodes an end element tag value (</elemName>). More...

EXTERNXML int	rtXmlEncEndSoapEnv (OSCTXT *pctxt)
	This function encodes a SOAP envelope end element tag (<SOAP-ENV:Envelope/>). More...

EXTERNXML int	rtXmlEncEndSoapElems (OSCTXT *pctxt, OSXMLSOAPMsgType msgtype)
	This function encodes SOAP end element tags. More...

EXTERNXML int	rtXmlEncFloat (OSCTXT pctxt, OSREAL value, const OSUTF8CHAR elemName, OSXMLNamespace pNS, const OSDoubleFmt pFmtSpec)
	This function encodes a variable of the XSD float type. More...

EXTERNXML int	rtXmlEncFloatAttr (OSCTXT pctxt, OSREAL value, const OSUTF8CHAR attrName, OSSIZE attrNameLen, const OSDoubleFmt *pFmtSpec)
	This function encodes a variable of the XSD float type as an attribute. More...

EXTERNXML int	rtXmlEncGYear (OSCTXT pctxt, const OSXSDDateTime pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a numeric gYear element into an XML string representation. More...

EXTERNXML int	rtXmlEncGYearMonth (OSCTXT pctxt, const OSXSDDateTime pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a numeric gYearMonth element into an XML string representation. More...

EXTERNXML int	rtXmlEncGMonth (OSCTXT pctxt, const OSXSDDateTime pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a numeric gMonth element into an XML string representation. More...

EXTERNXML int	rtXmlEncGMonthDay (OSCTXT pctxt, const OSXSDDateTime pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a numeric gMonthDay element into an XML string representation. More...

EXTERNXML int	rtXmlEncGDay (OSCTXT pctxt, const OSXSDDateTime pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a numeric gDay element into an XML string representation. More...

EXTERNXML int	rtXmlEncGYearValue (OSCTXT pctxt, const OSXSDDateTime pvalue)
	This function encodes a numeric gYear value into an XML string representation. More...

EXTERNXML int	rtXmlEncGYearMonthValue (OSCTXT pctxt, const OSXSDDateTime pvalue)
	This function encodes a numeric gYearMonth value into an XML string representation. More...

EXTERNXML int	rtXmlEncGMonthValue (OSCTXT pctxt, const OSXSDDateTime pvalue)
	This function encodes a numeric gMonth value into an XML string representation. More...

EXTERNXML int	rtXmlEncGMonthDayValue (OSCTXT pctxt, const OSXSDDateTime pvalue)
	This function encodes a numeric gMonthDay value into an XML string representation. More...

EXTERNXML int	rtXmlEncGDayValue (OSCTXT pctxt, const OSXSDDateTime pvalue)
	This function encodes a numeric gDay value into an XML string representation. More...

EXTERNXML int	rtXmlEncHexBinary (OSCTXT pctxt, OSSIZE nocts, const OSOCTET value, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the XSD hexBinary type. More...

EXTERNXML int	rtXmlEncHexBinaryAttr (OSCTXT pctxt, OSUINT32 nocts, const OSOCTET value, const OSUTF8CHAR *attrName, OSSIZE attrNameLen)
	This function encodes a variable of the XSD hexBinary type as an attribute. More...

EXTERNXML int	rtXmlEncHexStrValue (OSCTXT pctxt, OSSIZE nocts, const OSOCTET data)
	This function encodes a variable of the XSD hexBinary type. More...

EXTERNXML int	rtXmlEncIndent (OSCTXT *pctxt)
	This function adds indentation whitespace to the output stream. More...

EXTERNXML int	rtXmlEncInt (OSCTXT pctxt, OSINT32 value, const OSUTF8CHAR elemName, OSXMLNamespace *pNS)
	This function encodes a variable of the XSD integer type. More...

EXTERNXML int	rtXmlEncIntValue (OSCTXT *pctxt, OSINT32 value)
	This function encodes a variable of the XSD integer type. More...

EXTERNXML int	rtXmlEncIntAttr (OSCTXT pctxt, OSINT32 value, const OSUTF8CHAR attrName, OSSIZE attrNameLen)
	This function encodes a variable of the XSD integer type as an attribute (name="value"). More...

EXTERNXML int	rtXmlEncIntPattern (OSCTXT pctxt, OSINT32 value, const OSUTF8CHAR elemName, OSXMLNamespace pNS, const OSUTF8CHAR pattern)
	This function encodes a variable of the XSD integer type using a pattern to specify the format of the integer value. More...

EXTERNXML int	rtXmlEncIntPatternValue (OSCTXT pctxt, OSINT32 value, const OSUTF8CHAR pattern)

EXTERNXML int	rtXmlEncUIntPattern (OSCTXT pctxt, OSUINT32 value, const OSUTF8CHAR elemName, OSXMLNamespace pNS, const OSUTF8CHAR pattern)

EXTERNXML int	rtXmlEncUIntPatternValue (OSCTXT pctxt, OSUINT32 value, const OSUTF8CHAR pattern)

EXTERNXML int	rtXmlEncInt64 (OSCTXT pctxt, OSINT64 value, const OSUTF8CHAR elemName, OSXMLNamespace *pNS)
	This function encodes a variable of the XSD integer type. More...

EXTERNXML int	rtXmlEncInt64Pattern (OSCTXT pctxt, OSINT64 value, const OSUTF8CHAR elemName, OSXMLNamespace pNS, const OSUTF8CHAR pattern)

EXTERNXML int	rtXmlEncInt64Value (OSCTXT *pctxt, OSINT64 value)
	This function encodes a variable of the XSD integer type. More...

EXTERNXML int	rtXmlEncInt64PatternValue (OSCTXT pctxt, OSINT64 value, const OSUTF8CHAR pattern)

EXTERNXML int	rtXmlEncInt64Attr (OSCTXT pctxt, OSINT64 value, const OSUTF8CHAR attrName, OSSIZE attrNameLen)
	This function encodes a variable of the XSD integer type as an attribute (name="value"). More...

EXTERNXML int	rtXmlEncNamedBits (OSCTXT pctxt, const OSBitMapItem pBitMap, OSSIZE nbits, const OSOCTET pvalue, const OSUTF8CHAR elemName, OSXMLNamespace *pNS)
	This function encodes a variable of the ASN.1 BIT STRING type. More...

EXTERNXML int	rtXmlEncNamedBitsValue (OSCTXT pctxt, const OSBitMapItem pBitMap, OSSIZE nbits, const OSOCTET *pvalue)

EXTERNXML int	rtXmlEncNSAttrs (OSCTXT pctxt, OSRTDList pNSAttrs)
	This function encodes namespace declaration attributes at the beginning of an XML document. More...

EXTERNXML int	rtXmlPrintNSAttrs (const char name, const OSRTDList data)
	This function prints a list of namespace attributes. More...

EXTERNXML int	rtXmlEncReal10 (OSCTXT pctxt, const OSUTF8CHAR pvalue, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the ASN.1 REAL base 10 type. More...

EXTERNXML int	rtXmlEncSoapArrayTypeAttr (OSCTXT pctxt, const OSUTF8CHAR name, const OSUTF8CHAR *value, OSSIZE itemCount)
	This function encodes the special SOAP encoding attrType attribute which specifies the number and type of elements in a SOAP array. More...

EXTERNXML int	rtXmlEncSoapArrayTypeAttr2 (OSCTXT pctxt, const OSUTF8CHAR name, OSSIZE nameLen, const OSUTF8CHAR *value, OSSIZE valueLen, OSSIZE itemCount)

EXTERNXML int	rtXmlEncStartDocument (OSCTXT *pctxt)
	This function encodes the XML header text at the beginning of an XML document. More...

EXTERNXML int	rtXmlEncBOM (OSCTXT *pctxt)
	This function encodes the Unicode byte order mark header at the start of the document. More...

EXTERNXML int	rtXmlEncStartElement (OSCTXT pctxt, const OSUTF8CHAR elemName, OSXMLNamespace pNS, OSRTDList pNSAttrs, OSBOOL terminate)
	This function encodes a start element tag value (<elemName>). More...

EXTERNXML int	rtXmlEncStartSoapEnv (OSCTXT pctxt, OSRTDList pNSAttrs)
	This function encodes a SOAP envelope start element tag. More...

EXTERNXML int	rtXmlEncStartSoapElems (OSCTXT *pctxt, OSXMLSOAPMsgType msgtype)
	This function encodes a SOAP envelope start element tag and an optional SOAP body or fault tag. More...

EXTERNXML int	rtXmlEncString (OSCTXT pctxt, OSXMLSTRING pxmlstr, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a variable of the XSD string type. More...

EXTERNXML int	rtXmlEncStringValue (OSCTXT pctxt, const OSUTF8CHAR value)
	This function encodes a variable of the XSD string type. More...

EXTERNXML int	rtXmlEncStringValue2 (OSCTXT pctxt, const OSUTF8CHAR value, OSSIZE valueLen)
	This function encodes a variable of the XSD string type. More...

EXTERNXML int	rtXmlEncTermStartElement (OSCTXT *pctxt)
	This function terminates a currently open XML start element by adding either a '>' or '/>' (if empty) terminator. More...

EXTERNXML int	rtXmlEncUnicodeStr (OSCTXT pctxt, const OSUNICHAR value, OSSIZE nchars, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a Unicode string value. More...

EXTERNXML int	rtXmlEncUTF8Attr (OSCTXT pctxt, const OSUTF8CHAR name, const OSUTF8CHAR *value)
	This function encodes an attribute in which the name and value are given as a null-terminated UTF-8 strings. More...

EXTERNXML int	rtXmlEncUTF8Attr2 (OSCTXT pctxt, const OSUTF8CHAR name, OSSIZE nameLen, const OSUTF8CHAR *value, OSSIZE valueLen)
	This function encodes an attribute in which the name and value are given as a UTF-8 strings with lengths. More...

EXTERNXML int	rtXmlEncUTF8Str (OSCTXT pctxt, const OSUTF8CHAR value, const OSUTF8CHAR elemName, OSXMLNamespace pNS)
	This function encodes a UTF-8 string value. More...

EXTERNXML int	rtXmlEncUInt (OSCTXT pctxt, OSUINT32 value, const OSUTF8CHAR elemName, OSXMLNamespace *pNS)
	This function encodes a variable of the XSD unsigned integer type. More...

EXTERNXML int	rtXmlEncUIntValue (OSCTXT *pctxt, OSUINT32 value)
	This function encodes a variable of the XSD unsigned integer type. More...

EXTERNXML int	rtXmlEncUIntAttr (OSCTXT pctxt, OSUINT32 value, const OSUTF8CHAR attrName, OSSIZE attrNameLen)
	This function encodes a variable of the XSD unsigned integer type as an attribute (name="value"). More...

EXTERNXML int	rtXmlEncUInt64 (OSCTXT pctxt, OSUINT64 value, const OSUTF8CHAR elemName, OSXMLNamespace *pNS)
	This function encodes a variable of the XSD integer type. More...

EXTERNXML int	rtXmlEncUInt64Pattern (OSCTXT pctxt, OSUINT64 value, const OSUTF8CHAR elemName, OSXMLNamespace pNS, const OSUTF8CHAR pattern)

EXTERNXML int	rtXmlEncUInt64Value (OSCTXT *pctxt, OSUINT64 value)
	This function encodes a variable of the XSD integer type. More...

EXTERNXML int	rtXmlEncUInt64PatternValue (OSCTXT pctxt, OSUINT64 value, const OSUTF8CHAR pattern)

EXTERNXML int	rtXmlEncUInt64Attr (OSCTXT pctxt, OSUINT64 value, const OSUTF8CHAR attrName, OSSIZE attrNameLen)
	This function encodes a variable of the XSD integer type as an attribute (name="value"). More...

EXTERNXML int	rtXmlEncXSIAttrs (OSCTXT *pctxt, OSBOOL needXSI)
	This function encodes XML schema instance (XSI) attributes at the beginning of an XML document. More...

EXTERNXML int	rtXmlEncXSITypeAttr (OSCTXT pctxt, const OSUTF8CHAR value)
	This function encodes an XML schema instance (XSI) type attribute value (xsi:type="value"). More...

EXTERNXML int	rtXmlEncXSITypeAttr2 (OSCTXT pctxt, const OSUTF8CHAR typeNsUri, const OSUTF8CHAR *typeName)
	This function encodes an XML schema instance (XSI) type attribute value (xsi:type="pfx:value"). More...

EXTERNXML int	rtXmlEncXSINilAttr (OSCTXT *pctxt)
	This function encodes an XML nil attribute (xsi:nil="true"). More...

EXTERNXML int	rtXmlFreeInputSource (OSCTXT *pctxt)
	This function closes an input source that was previously created with one of the create input source functions such as 'rtXmlCreateFileInputSource'. More...

EXTERNXML OSBOOL	rtXmlStrCmpAsc (const OSUTF8CHAR text1, const char text2)

EXTERNXML OSBOOL	rtXmlStrnCmpAsc (const OSUTF8CHAR text1, const char text2, OSSIZE len)

EXTERNXML int	rtXmlSetEncBufPtr (OSCTXT pctxt, OSOCTET bufaddr, OSSIZE bufsiz)
	This function is used to set the internal buffer within the run-time library encoding context. More...

EXTERNXML int	rtXmlGetIndent (OSCTXT *pctxt)
	This function returns current XML output indent value. More...

EXTERNXML OSBOOL	rtXmlGetWriteBOM (OSCTXT *pctxt)
	This function returns whether the Unicode byte order mark will be encoded. More...

EXTERNXML int	rtXmlGetIndentChar (OSCTXT *pctxt)
	This function returns current XML output indent character value (default is space). More...

EXTERNXML int	rtXmlPrepareContext (OSCTXT *pctxt)
	This function prepares the context for another encode by setting the state back to OSXMLINIT and moving the buffer's cursor back to the beginning of the buffer. More...

EXTERNXML int	rtXmlSetEncC14N (OSCTXT *pctxt, OSBOOL value)
	This function sets the option to encode in C14N mode. More...

EXTERNXML int	rtXmlSetEncXSINamespace (OSCTXT *pctxt, OSBOOL value)
	This function sets a flag in the context that indicates the XSI namespace declaration (xmlns:xsi) should be added to the encoded XML instance. More...

EXTERNXML int	rtXmlSetEncXSINilAttr (OSCTXT *pctxt, OSBOOL value)
	This function sets a flag in the context that indicates the XSI attribute declaration (xmlns:xsi) should be added to the encoded XML instance. More...

EXTERNXML int	rtXmlSetDigitsFacets (OSCTXT *pctxt, int totalDigits, int fractionDigits)

EXTERNXML int	rtXmlSetEncDocHdr (OSCTXT *pctxt, OSBOOL value)
	This function sets the option to add the XML document header (i.e. More...

EXTERNXML int	rtXmlSetEncodingStr (OSCTXT pctxt, const OSUTF8CHAR encodingStr)
	This function sets the XML output encoding to the given value. More...

EXTERNXML int	rtXmlSetFormatting (OSCTXT *pctxt, OSBOOL doFormatting)
	This function sets XML output formatting to the given value. More...

EXTERNXML int	rtXmlSetIndent (OSCTXT *pctxt, OSUINT8 indent)
	This function sets XML output indent to the given value. More...

EXTERNXML int	rtXmlSetIndentChar (OSCTXT *pctxt, char indentChar)
	This function sets XML output indent character to the given value. More...

EXTERNXML void	rtXmlSetNamespacesSet (OSCTXT *pctxt, OSBOOL value)
	This function sets the context 'namespaces are set' flag. More...

EXTERNXML int	rtXmlSetNSPrefixLinks (OSCTXT pctxt, OSRTDList pNSAttrs)
	This function sets namespace prefix/URI links in the namspace prefix stack in the context structure. More...

EXTERNXML int	rtXmlSetSchemaLocation (OSCTXT pctxt, const OSUTF8CHAR schemaLocation)
	This function sets the XML Schema Instance (xsi) schema location attribute to be added to an encoded document. More...

EXTERNXML int	rtXmlSetNoNSSchemaLocation (OSCTXT pctxt, const OSUTF8CHAR schemaLocation)
	This function sets the XML Schema Instance (xsi) no namespace schema location attribute to be added to an encoded document. More...

EXTERNXML void	rtXmlSetSoapVersion (OSCTXT *pctxt, OSUINT8 version)
	This function sets the SOAP version number. More...

EXTERNXML int	rtXmlSetXSITypeAttr (OSCTXT pctxt, const OSUTF8CHAR xsiType)
	This function sets the XML Schema Instance (xsi) type attribute value. More...

EXTERNXML int	rtXmlSetWriteBOM (OSCTXT *pctxt, OSBOOL write)
	This function sets whether the Unicode byte order mark is encoded. More...

EXTERNXML int	rtXmlMatchHexStr (OSCTXT *pctxt, OSSIZE minLength, OSSIZE maxLength)
	This function tests the context buffer for containing a correct hexadecimal string. More...

EXTERNXML int	rtXmlMatchBase64Str (OSCTXT *pctxt, OSSIZE minLength, OSSIZE maxLength)
	This function tests the context buffer for containing a correct base64 string. More...

EXTERNXML int	rtXmlMatchDate (OSCTXT *pctxt)
	This function tests the context buffer for containing a correct date string. More...

EXTERNXML int	rtXmlMatchTime (OSCTXT *pctxt)
	This function tests the context buffer for containing a correct time string. More...

EXTERNXML int	rtXmlMatchDateTime (OSCTXT *pctxt)
	This function tests the context buffer for containing a correct dateTime string. More...

EXTERNXML int	rtXmlMatchGYear (OSCTXT *pctxt)
	This function tests the context buffer for containing a correct gYear string. More...

EXTERNXML int	rtXmlMatchGYearMonth (OSCTXT *pctxt)
	This function tests the context buffer for containing a correct gYearMonth string. More...

EXTERNXML int	rtXmlMatchGMonth (OSCTXT *pctxt)
	This function tests the context buffer for containing a correct gMonth string. More...

EXTERNXML int	rtXmlMatchGMonthDay (OSCTXT *pctxt)
	This function tests the context buffer for containing a correct gMonthDay string. More...

EXTERNXML int	rtXmlMatchGDay (OSCTXT *pctxt)
	This function tests the context buffer for containing a correct gDay string. More...

EXTERNXML OSUTF8CHAR *	rtXmlNewQName (OSCTXT pctxt, const OSUTF8CHAR localName, const OSUTF8CHAR *prefix)
	This function creates a new QName given the localName and prefix parts. More...

EXTERNXML OSBOOL	rtXmlCmpBase64Str (OSUINT32 nocts1, const OSOCTET data1, const OSUTF8CHAR data2)
	This function compares an array of octets to a base64 string. More...

EXTERNXML OSBOOL	rtXmlCmpHexStr (OSUINT32 nocts1, const OSOCTET data1, const OSUTF8CHAR data2)
	This function compares an array of octets to a hex string. More...

EXTERNXML OSBOOL	rtXmlCmpHexChar (OSUTF8CHAR ch, OSOCTET hexval)

EXTERNXML int	rtSaxGetAttributeID (const OSUTF8CHAR attrName, OSSIZE nAttr, const OSUTF8CHAR attrNames[], OSUINT32 attrPresent[])

EXTERNXML const OSUTF8CHAR *	rtSaxGetAttrValue (const OSUTF8CHAR attrName, const OSUTF8CHAR const *attrs)
	This function looks up an attribute in the attribute array returned by SAX to the startElement function. More...

EXTERNXML OSINT16	rtSaxGetElemID (OSINT16 pState, OSINT16 prevElemIdx, const OSUTF8CHAR localName, OSINT32 nsidx, const OSSAXElemTableRec idtab[], const OSINT16 *fstab, OSINT16 fstabRows, OSINT16 fstabCols)
	This function looks up a sequence element name in the given element info array. More...

EXTERNXML OSINT16	rtSaxGetElemID8 (OSINT16 pState, OSINT16 prevElemIdx, const OSUTF8CHAR localName, OSINT32 nsidx, const OSSAXElemTableRec idtab[], const OSINT8 *fstab, OSINT16 fstabRows, OSINT16 fstabCols)
	This function is a space optimized version of `rtSaxGetElemID`. More...

EXTERNXML OSINT16	rtSaxFindElemID (OSINT16 pState, OSINT16 prevElemIdx, const OSUTF8CHAR localName, OSINT32 nsidx, const OSSAXElemTableRec idtab[], const OSINT16 *fstab, OSINT16 fstabRows, OSINT16 fstabCols)

EXTERNXML OSINT16	rtSaxFindElemID8 (OSINT16 pState, OSINT16 prevElemIdx, const OSUTF8CHAR localName, OSINT32 nsidx, const OSSAXElemTableRec idtab[], const OSINT8 *fstab, OSINT16 fstabRows, OSINT16 fstabCols)

EXTERNXML OSBOOL	rtSaxHasXMLNSAttrs (const OSUTF8CHAR const attrs)
	This function checks if the given attribute list contains one or more XML namespace attributes (xmlns). More...

EXTERNXML OSBOOL	rtSaxIsEmptyBuffer (OSCTXT *pctxt)
	This function checks if the buffer in the context is empty or not. More...

EXTERNXML OSINT16	rtSaxLookupElemID (OSCTXT pctxt, OSINT16 pState, OSINT16 prevElemIdx, const OSUTF8CHAR localName, const OSUTF8CHAR qName, OSINT32 nsidx, const OSSAXElemTableRec idtab[], const OSINT16 *fstab, OSINT16 fstabRows, OSINT16 fstabCols)

EXTERNXML OSINT16	rtSaxLookupElemID8 (OSCTXT pctxt, OSINT16 pState, OSINT16 prevElemIdx, const OSUTF8CHAR localName, const OSUTF8CHAR qName, OSINT32 nsidx, const OSSAXElemTableRec idtab[], const OSINT8 *fstab, OSINT16 fstabRows, OSINT16 fstabCols)

EXTERNXML int	rtSaxStrListParse (OSCTXT pctxt, OSRTMEMBUF pMemBuf, OSRTDList *pvalue)
	This function parses the list of strings. More...

EXTERNXML int	rtSaxSortAttrs (OSCTXT pctxt, const OSUTF8CHAR const attrs, OSUINT16 *order)
	This function sorts a SAX attribute list in ascending order based on attribute name. More...

EXTERNXML int	rtSaxStrListMatch (OSCTXT *pctxt)
	This function mathes the list of strings. More...

EXTERNXML OSBOOL	rtSaxTestFinal (OSINT16 state, OSINT16 currElemIdx, const int *fstab, int fstabRows, int fstabCols)

EXTERNXML OSBOOL	rtSaxTestFinal8 (OSINT16 state, OSINT16 currElemIdx, const OSINT8 *fstab, int fstabRows, int fstabCols)

EXTERNXML int	rtSaxSetSkipLevelToCurrent (OSCTXT *pctxt, int stat)

EXTERNXML OSUINT32	rtSaxSetMaxErrors (OSCTXT *pctxt, OSUINT32 maxErrors)

EXTERNXML OSUINT32	rtSaxGetMaxErrors (OSCTXT *pctxt)

EXTERNXML int	rtSaxTestAttributesPresent (OSCTXT pctxt, const OSUINT32 attrPresent, const OSUINT32 reqAttrMask, const OSUTF8CHAR const attrNames, OSSIZE numOfAttrs, const char parentTypeName)

EXTERNXML OSBOOL	rtSaxIncErrors (OSCTXT *pctxt)

EXTERNXML int	rtSaxReportUnexpAttrs (OSCTXT pctxt, const OSUTF8CHAR const attrs, const char typeName)

EXTERNXML int	rtXmlWriteToFile (OSCTXT pctxt, const char filename)
	This function writes the encoded XML message stored in the context message buffer out to a file. More...

EXTERNXML int	rtXmlWriteUTF16ToFile (OSCTXT pctxt, const char filename)

EXTERNXML void	rtXmlTreatWhitespaces (OSCTXT *pctxt, int whiteSpaceType)

EXTERNXML int	rtXmlCheckBuffer (OSCTXT *pctxt, OSSIZE byte_count)

EXTERNXML void	rtErrXmlInit (OSVOIDARG)

EXTERNXML int	rtXmlPutChar (OSCTXT *pctxt, const OSUTF8CHAR value)

EXTERNXML int	rtXmlWriteChars (OSCTXT pctxt, const OSUTF8CHAR value, OSSIZE len)

EXTERNXML int	rtXmlpDecAny (OSCTXT pctxt, const OSUTF8CHAR *pvalue)
	This function decodes an arbitrary XML section of code as defined by the XSD any type (xsd:any). More...

EXTERNXML int	rtXmlpDecAny2 (OSCTXT pctxt, OSUTF8CHAR *pvalue)
	This version of the rtXmlpDecAny function returns the string in a mutable buffer. More...

EXTERNXML int	rtXmlpDecAnyAttrStr (OSCTXT pctxt, const OSUTF8CHAR *ppAttrStr, OSSIZE attrIndex)
	This function decodes an any attribute string. More...

EXTERNXML int	rtXmlpDecAnyElem (OSCTXT pctxt, const OSUTF8CHAR *pvalue)
	This function decodes an arbitrary XML section of code as defined by the XSD any type (xsd:any). More...

EXTERNXML int	rtXmlpDecBase64Str (OSCTXT pctxt, OSOCTET pvalue, OSUINT32 *pnocts, OSSIZE bufsize)
	This function decodes a contents of a Base64-encode binary string into a static memory structure. More...

EXTERNXML int	rtXmlpDecBase64Str64 (OSCTXT pctxt, OSOCTET pvalue, OSSIZE *pnocts, OSSIZE bufsize)
	This function is identical to rtXmlpDecBase64Str except that it supports 64-bit integer lengths on 64-bit systems. More...

EXTERNXML int	rtXmlpDecBigInt (OSCTXT pctxt, const OSUTF8CHAR *pvalue)
	This function will decode a variable of the XSD integer type. More...

EXTERNXML int	rtXmlpDecBitString (OSCTXT pctxt, OSOCTET pvalue, OSUINT32 *pnbits, OSUINT32 bufsize)
	This function decodes a bit string value. More...

EXTERNXML int	rtXmlpDecBitString64 (OSCTXT pctxt, OSOCTET pvalue, OSSIZE *pnbits, OSSIZE bufsize)
	This function is identical to rtXmlpDecBitString except that it supports lengths up to 64-bits in size on 64-bit machines. More...

EXTERNXML int	rtXmlpDecBitStringExt (OSCTXT pctxt, OSOCTET pvalue, OSUINT32 pnbits, OSOCTET *ppextdata, OSUINT32 bufsize)
	This function decodes a bit string value. More...

EXTERNXML int	rtXmlpDecBitStringExt64 (OSCTXT pctxt, OSOCTET pvalue, OSSIZE pnbits, OSOCTET *ppextdata, OSSIZE bufsize)
	This function is identical to rtXmlpDecBitStringExt except that it supports lengths up to 64-bits in size on 64-bit machines. More...

EXTERNXML int	rtXmlpDecBool (OSCTXT pctxt, OSBOOL pvalue)
	This function decodes a variable of the boolean type. More...

EXTERNXML int	rtXmlpDecDate (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'date' type. More...

EXTERNXML int	rtXmlpDecDateTime (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'dateTime' type. More...

EXTERNXML int	rtXmlpDecDecimal (OSCTXT pctxt, OSREAL pvalue, int totalDigits, int fractionDigits)
	This function decodes the contents of a decimal data type. More...

EXTERNXML int	rtXmlpDecDouble (OSCTXT pctxt, OSREAL pvalue)
	This function decodes the contents of a float or double data type. More...

EXTERNXML int	rtXmlpDecDoubleExt (OSCTXT pctxt, OSUINT8 flags, OSREAL pvalue)
	This function decodes the contents of a float or double data type. More...

EXTERNXML int	rtXmlpDecDynBase64Str (OSCTXT pctxt, OSDynOctStr pvalue)
	This function decodes a contents of a Base64-encode binary string. More...

EXTERNXML int	rtXmlpDecDynBase64Str64 (OSCTXT pctxt, OSDynOctStr64 pvalue)
	This function is identical to rtXmlpDecDynBase64Str except that it supports 64-bit integer lengths on 64-bit systems. More...

EXTERNXML int	rtXmlpDecDynBitString (OSCTXT pctxt, OSDynOctStr pvalue)
	This function decodes a bit string value. More...

EXTERNXML int	rtXmlpDecDynHexStr (OSCTXT pctxt, OSDynOctStr pvalue)
	This function decodes a contents of a hexBinary string. More...

EXTERNXML int	rtXmlpDecDynHexStr64 (OSCTXT pctxt, OSDynOctStr64 pvalue)
	This function is identical to the rtXmlpDecDynHexStr except that it supports lengths up to 64 bits in size on 64-bit systems. More...

EXTERNXML int	rtXmlpDecDynUnicodeStr (OSCTXT pctxt, const OSUNICHAR ppdata, OSSIZE pnchars)
	This function decodes a Unicode string data type. More...

EXTERNXML int	rtXmlpDecDynUTF8Str (OSCTXT pctxt, const OSUTF8CHAR *outdata)
	This function decodes the contents of a UTF-8 string data type. More...

EXTERNXML int	rtXmlpDecUTF8Str (OSCTXT pctxt, OSUTF8CHAR out, OSSIZE max_len)
	This function decodes the contents of a UTF-8 string data type. More...

EXTERNXML int	rtXmlpDecGDay (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gDay' type. More...

EXTERNXML int	rtXmlpDecGMonth (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gMonth' type. More...

EXTERNXML int	rtXmlpDecGMonthDay (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gMonthDay' type. More...

EXTERNXML int	rtXmlpDecGYear (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gYear' type. More...

EXTERNXML int	rtXmlpDecGYearMonth (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'gYearMonth' type. More...

EXTERNXML int	rtXmlpDecHexStr (OSCTXT pctxt, OSOCTET pvalue, OSUINT32 *pnocts, OSSIZE bufsize)
	This function decodes the contents of a hexBinary string into a static memory structure. More...

EXTERNXML int	rtXmlpDecHexStr64 (OSCTXT pctxt, OSOCTET pvalue, OSSIZE *pnocts, OSSIZE bufsize)
	This function is identical to rtXmlpDecHexStr except that it supports lengths up to 64-bits in size on 64-bit machines. More...

EXTERNXML int	rtXmlpDecInt (OSCTXT pctxt, OSINT32 pvalue)
	This function decodes the contents of a 32-bit integer data type. More...

EXTERNXML int	rtXmlpDecInt8 (OSCTXT pctxt, OSINT8 pvalue)
	This function decodes the contents of an 8-bit integer data type (i.e. More...

EXTERNXML int	rtXmlpDecInt16 (OSCTXT pctxt, OSINT16 pvalue)
	This function decodes the contents of a 16-bit integer data type. More...

EXTERNXML int	rtXmlpDecInt64 (OSCTXT pctxt, OSINT64 pvalue)
	This function decodes the contents of a 64-bit integer data type. More...

EXTERNXML int	rtXmlpDecNamedBits (OSCTXT pctxt, const OSBitMapItem pBitMap, OSOCTET pvalue, OSUINT32 pnbits, OSUINT32 bufsize)
	This function decodes the contents of a named bit field. More...

EXTERNXML int	rtXmlpDecNamedBits64 (OSCTXT pctxt, const OSBitMapItem pBitMap, OSOCTET pvalue, OSSIZE pnbits, OSSIZE bufsize)
	This function decodes the contents of a named bit field. More...

EXTERNXML int	rtXmlpDecStrList (OSCTXT pctxt, OSRTDList plist)
	This function decodes a list of space-separated tokens and returns each token as a separate item on the given list. More...

EXTERNXML int	rtXmlpDecTime (OSCTXT pctxt, OSXSDDateTime pvalue)
	This function decodes a variable of the XSD 'time' type. More...

EXTERNXML int	rtXmlpDecUInt (OSCTXT pctxt, OSUINT32 pvalue)
	This function decodes the contents of an unsigned 32-bit integer data type. More...

EXTERNXML int	rtXmlpDecUInt8 (OSCTXT pctxt, OSOCTET pvalue)
	This function decodes the contents of an unsigned 8-bit integer data type (i.e. More...

EXTERNXML int	rtXmlpDecUInt16 (OSCTXT pctxt, OSUINT16 pvalue)
	This function decodes the contents of an unsigned 16-bit integer data type. More...

EXTERNXML int	rtXmlpDecUInt64 (OSCTXT pctxt, OSUINT64 pvalue)
	This function decodes the contents of an unsigned 64-bit integer data type. More...

EXTERNXML int	rtXmlpDecXmlStr (OSCTXT pctxt, OSXMLSTRING outdata)
	This function decodes the contents of an XML string data type. More...

EXTERNXML int	rtXmlpDecXmlStrList (OSCTXT pctxt, OSRTDList plist)
	This function decodes a list of space-separated tokens and returns each token as a separate item on the given list. More...

EXTERNXML int	rtXmlpDecXSIAttr (OSCTXT pctxt, const OSXMLNameFragments attrName)
	This function decodes XSI (XML Schema Instance) attributes that may be present in any arbitrary XML element within a document. More...

EXTERNXML int	rtXmlpDecXSITypeAttr (OSCTXT pctxt, const OSXMLNameFragments attrName, const OSUTF8CHAR **ppAttrValue)
	This function decodes the contents of an XSI (XML Schema Instance) type attribute (xsi:type). More...

EXTERNXML int	rtXmlpGetAttributeID (const OSXMLStrFragment *attrName, OSINT16 nsidx, OSSIZE nAttr, const OSXMLAttrDescr attrNames[], OSUINT32 attrPresent[])
	This function finds an attribute in the descriptor table. More...

EXTERNXML int	rtXmlpGetNextElem (OSCTXT pctxt, OSXMLElemDescr pElem, OSINT32 level)
	This function parse the next element start tag. More...

EXTERNXML int	rtXmlpGetNextElemID (OSCTXT pctxt, const OSXMLElemIDRec tab, OSSIZE nrows, OSINT32 level, OSBOOL continueParse)
	This function parses the next start tag and finds the index of the element name in the descriptor table. More...

EXTERNXML int	rtXmlpMarkLastEventActive (OSCTXT *pctxt)
	This function marks current tag as unprocessed. More...

EXTERNXML int	rtXmlpMatchStartTag (OSCTXT pctxt, const OSUTF8CHAR elemLocalName, OSINT16 nsidx)
	This function parses the next start tag that matches with given name. More...

EXTERNXML int	rtXmlpMatchEndTag (OSCTXT *pctxt, OSINT32 level)
	This function parse next end tag that matches with given name. More...

EXTERNXML OSBOOL	rtXmlpHasAttributes (OSCTXT *pctxt)
	This function checks accessibility of attributes. More...

EXTERNXML int	rtXmlpGetAttributeCount (OSCTXT *pctxt)
	This function returns number of attributes in last processed start tag. More...

EXTERNXML int	rtXmlpSelectAttribute (OSCTXT pctxt, OSXMLNameFragments pAttr, OSINT16 *nsidx, OSSIZE attrIndex)
	This function selects attribute to decode. More...

EXTERNXML OSINT32	rtXmlpGetCurrentLevel (OSCTXT *pctxt)
	This function returns current nesting level. More...

EXTERNXML void	rtXmlpSetWhiteSpaceMode (OSCTXT *pctxt, OSXMLWhiteSpaceMode whiteSpaceMode)
	Sets the whitespace treatment mode. More...

EXTERNXML OSBOOL	rtXmlpSetMixedContentMode (OSCTXT *pctxt, OSBOOL mixedContentMode)
	Sets mixed content mode. More...

EXTERNXML void	rtXmlpSetListMode (OSCTXT *pctxt)
	Sets list mode. More...

EXTERNXML OSBOOL	rtXmlpListHasItem (OSCTXT *pctxt)
	Check for end of decoded token list. More...

EXTERNXML void	rtXmlpCountListItems (OSCTXT pctxt, OSSIZE itemCnt)
	Count tokens in list. More...

EXTERNXML int	rtXmlpGetNextSeqElemID2 (OSCTXT pctxt, const OSXMLElemIDRec tab, const OSXMLGroupDesc *pGroup, int groups, int curID, int lastMandatoryID, OSBOOL groupMode, OSBOOL checkRepeat)
	This function parses the next start tag and finds index of element name in descriptor table. More...

EXTERNXML int	rtXmlpGetNextSeqElemID (OSCTXT pctxt, const OSXMLElemIDRec tab, const OSXMLGroupDesc *pGroup, int curID, int lastMandatoryID, OSBOOL groupMode)
	This function parses the next start tag and finds index of element name in descriptor table. More...

EXTERNXML int	rtXmlpGetNextSeqElemIDExt (OSCTXT pctxt, const OSXMLElemIDRec tab, const OSXMLGroupDesc ppGroup, const OSBOOL extRequired, int postExtRootID, int curID, int lastMandatoryID, OSBOOL groupMode)
	This is an ASN.1 extension-supporting version of rtXmlpGetNextSeqElemID. More...

EXTERNXML int	rtXmlpGetNextAllElemID (OSCTXT pctxt, const OSXMLElemIDRec tab, OSSIZE nrows, const OSUINT8 *pOrder, OSSIZE nOrder, OSSIZE maxOrder, int anyID)
	This function parses the next start tag and finds index of element name in descriptor table. More...

EXTERNXML int	rtXmlpGetNextAllElemID16 (OSCTXT pctxt, const OSXMLElemIDRec tab, OSSIZE nrows, const OSUINT16 *pOrder, OSSIZE nOrder, OSSIZE maxOrder, int anyID)
	This function parses the next start tag and finds index of element name in descriptor table. More...

EXTERNXML int	rtXmlpGetNextAllElemID32 (OSCTXT pctxt, const OSXMLElemIDRec tab, OSSIZE nrows, const OSUINT32 *pOrder, OSSIZE nOrder, OSSIZE maxOrder, int anyID)
	This function parses the next start tag and finds index of element name in descriptor table. More...

EXTERNXML void	rtXmlpSetNamespaceTable (OSCTXT pctxt, const OSUTF8CHAR namespaceTable[], OSSIZE nmNamespaces)
	Sets user namespace table. More...

EXTERNXML int	rtXmlpCreateReader (OSCTXT *pctxt)
	Creates pull parser reader structure within the context. More...

EXTERNXML void	rtXmlpHideAttributes (OSCTXT *pctxt)
	Disable access to attributes. More...

EXTERNXML OSBOOL	rtXmlpNeedDecodeAttributes (OSCTXT *pctxt)
	This function checks if attributes were previously decoded. More...

EXTERNXML void	rtXmlpMarkPos (OSCTXT *pctxt)
	Save current decode position. More...

EXTERNXML void	rtXmlpRewindToMarkedPos (OSCTXT *pctxt)
	Rewind to saved decode position. More...

EXTERNXML void	rtXmlpResetMarkedPos (OSCTXT *pctxt)
	Reset saved decode position. More...

EXTERNXML int	rtXmlpGetXSITypeAttr (OSCTXT pctxt, const OSUTF8CHAR ppAttrValue, OSINT16 nsidx, OSSIZE *pLocalOffs)
	This function decodes the contents of an XSI (XML Schema Instance) type attribute (xsi:type). More...

EXTERNXML int	rtXmlpGetXmlnsAttrs (OSCTXT pctxt, OSRTDList pNSAttrs)
	This function decodes namespace attributes from start tag and adds them to the given list. More...

EXTERNXML int	rtXmlpDecXSIAttrs (OSCTXT *pctxt)
	This function decodes XSI (XML Schema Instance) that may be present in any arbitrary XML element within a document. More...

EXTERNXML OSBOOL	rtXmlpIsEmptyElement (OSCTXT *pctxt)
	Check element content: empty or not. More...

EXTERNXML int	rtXmlEncAttrC14N (OSCTXT *pctxt)
	This function used only in C14 mode. More...

EXTERNXML struct OSXMLReader *	rtXmlpGetReader (OSCTXT *pctxt)
	This function fetches the XML reader structure from the context for use in low-level pull parser calls. More...

EXTERNXML OSBOOL	rtXmlpIsLastEventDone (OSCTXT *pctxt)
	Check processing status of current tag. More...

EXTERNXML int	rtXmlpGetXSITypeIndex (OSCTXT *pctxt, const OSXMLItemDescr typetab[], OSSIZE typetabsiz)
	This function decodes the contents of an XSI (XML Schema Instance) type attribute (xsi:type) and find type index in descriptor table. More...

EXTERNXML int	rtXmlpLookupXSITypeIndex (OSCTXT pctxt, const OSUTF8CHAR pXsiType, OSINT16 xsiTypeIdx, const OSXMLItemDescr typetab[], OSSIZE typetabsiz)
	This function find index of XSI (XML Schema Instance) type in descriptor table. More...

EXTERNXML void	rtXmlpForceDecodeAsGroup (OSCTXT *pctxt)
	Disable skipping of unknown elements in optional sequence tail. More...

EXTERNXML OSBOOL	rtXmlpIsDecodeAsGroup (OSCTXT *pctxt)
	This function checks if "decode as group" mode was forced. More...

EXTERNXML OSBOOL	rtXmlpIsUTF8Encoding (OSCTXT *pctxt)
	This function checks if the encoding specified in XML header is UTF-8. More...

EXTERNXML int	rtXmlpReadBytes (OSCTXT pctxt, OSOCTET pbuf, OSSIZE nbytes)
	This function reads the specified number of bytes directly from the underlying XML parser stream. More...

Detailed Description

XML low-level C encode/decode functions.

Definition in file osrtxml.h.

Macro Definition Documentation

◆ IS_XMLNSATTR

#define IS_XMLNSATTR ( name )

Value:

((OSUTF8LEN(name) >= 5) && name[0] == 'x' && name[1] == 'm' && \

name[2] == 'l' && name[3] == 'n' && name[4] == 's')

Definition at line 186 of file osrtxml.h.

◆ IS_XSIATTR

#define IS_XSIATTR ( name )

Value:

((OSUTF8LEN(name) >= 4) && name[0] == 'x' && name[1] == 's' && \

name[2] == 'i' && name[3] == ':')

Definition at line 190 of file osrtxml.h.

◆ OSASN1XER

#define OSASN1XER

Value:

0x00000008  /* if true, -xml code and runtime
                                       should produce XER encodings
                                       instead of Obj-Sys encodings     */

Definition at line 75 of file osrtxml.h.

◆ OSHASDEFAULT

#define OSHASDEFAULT

Value:

0x00000010  /* decode should accept values which
                                       are empty after whitespace processing
                                       because the element has a default
                                       value                            */

Definition at line 71 of file osrtxml.h.

◆ OSXMLC14N

#define OSXMLC14N

Value:

0x00000200  /* Flag used to indicate XML canonical
                                       encode when OSASN1XER is not set, or
                                       canonical XER when OSASN1XER is set. */

Definition at line 65 of file osrtxml.h.

◆ OSXMLQNAMEEQUALS

#define OSXMLQNAMEEQUALS	(	xnamefrag,
		qnametext
	)

Value:

rtxUTF8StrnEqual \

(xnamefrag.mQName.value, OSUTF8(qnametext), xnamefrag.mQName.length)

Definition at line 179 of file osrtxml.h.

◆ OSXMLSETUTF8DECPTR

#define OSXMLSETUTF8DECPTR	(	pctxt,
		str
	)

Value:

rtxInitContextBuffer (pctxt, OSRTSAFECONSTCAST (OSOCTET*, str), \

OSUTF8LEN (str))

Definition at line 182 of file osrtxml.h.

Typedef Documentation

◆ OSXMLGroupDesc

typedef struct OSXMLGroupDesc OSXMLGroupDesc

OSXMLGroupDesc describes how entries in an OSXMLElemIDRec array make up a group.

Here, "group" means a set of elements, any of which may be matched next. This does not correspond directly to an XSD group.

For example, if elementA is optional and followed by non-optional elementB, then there will be a group that contains both elements. There will also be a group that contains only elementB; this will be the group of interest after elementA is matched.

Function Documentation

◆ rtSaxGetAttrValue()

EXTERNXML const OSUTF8CHAR* rtSaxGetAttrValue	(	const OSUTF8CHAR *	attrName,
		const OSUTF8CHAR const	attrs
	)

This function looks up an attribute in the attribute array returned by SAX to the startElement function.

Parameters

attrName	Name of the attribute to find.
attrs	Attribute array returned in SAX startElement function. This is an array of character strings containing name1, value1, name2, value2, ... List is terminated by a null name.

Returns: Pointer to character string containing attribute value or NULL if attrName not found.

◆ rtSaxGetElemID()

EXTERNXML OSINT16 rtSaxGetElemID	(	OSINT16 *	pState,
		OSINT16	prevElemIdx,
		const OSUTF8CHAR *	localName,
		OSINT32	nsidx,
		const OSSAXElemTableRec	idtab[],
		const OSINT16 *	fstab,
		OSINT16	fstabRows,
		OSINT16	fstabCols
	)

This function looks up a sequence element name in the given element info array.

If ensures elements are received in the correct order and also sets the required element count variable.

Parameters

pState	The pointer to state variable to be changed.
prevElemIdx	Previous index of element. The search will be started from this element for better performance.
localName	Local name of XML element
nsidx	Namespace index
idtab	Element ID table
fstab	Finite state table
fstabRows	Number of rows in `fstab`.
fstabCols	Number of columns in `fstab`.

◆ rtSaxGetElemID8()

EXTERNXML OSINT16 rtSaxGetElemID8	(	OSINT16 *	pState,
		OSINT16	prevElemIdx,
		const OSUTF8CHAR *	localName,
		OSINT32	nsidx,
		const OSSAXElemTableRec	idtab[],
		const OSINT8 *	fstab,
		OSINT16	fstabRows,
		OSINT16	fstabCols
	)

This function is a space optimized version of rtSaxGetElemID.

It operates with array of 8-bit integers (OSINT8) instead of 32-bit integers (int).

Parameters

pState	The pointer to state variable to be changed.
prevElemIdx	Previous index of element. The search will be started from this element + 1 for better performance.
localName	Local name of XML element
nsidx	Namespace index
idtab	Element ID table
fstab	Finite state table (array of 8-bit integers)
fstabRows	Number of rows in `fstab`.
fstabCols	Number of columns in `fstab`.

◆ rtSaxHasXMLNSAttrs()

EXTERNXML OSBOOL rtSaxHasXMLNSAttrs ( const OSUTF8CHAR *const * attrs )

This function checks if the given attribute list contains one or more XML namespace attributes (xmlns).

Parameters

attrs Attribute list in form passed by parser into SAX startElement function.

Returns: TRUE, if xmlns attribute found in list.

◆ rtSaxIsEmptyBuffer()

EXTERNXML OSBOOL rtSaxIsEmptyBuffer ( OSCTXT * pctxt )

This function checks if the buffer in the context is empty or not.

Parameters

pctxt Pointer to OSCTXT structure

Returns: TRUE, if the buffer contains empty string.

◆ rtSaxSortAttrs()

EXTERNXML int rtSaxSortAttrs	(	OSCTXT *	pctxt,
		const OSUTF8CHAR const	attrs,
		OSUINT16 **	order
	)

This function sorts a SAX attribute list in ascending order based on attribute name.

It currently only supports unqualified attributes.

Parameters

pctxt	Pointer to OSCTXT structure.
attrs	Standard SAX attribute list. Entry i is attribute name and i+1 is value. List is terminated by a null name.
order	Order array containing the order of sorted attributes. This array is allocated using rtxMemAlloc, it can be freed using rtxMemFreePtr or will be freed when the context is freed. The list holds indicies to name items in the attribute list that is passed in.

Returns: If success, positive value contains number of attributes in attrs; if failure, negative status code.

◆ rtSaxStrListMatch()

EXTERNXML int rtSaxStrListMatch ( OSCTXT * pctxt )

This function mathes the list of strings.

It is used for matching NMTOKENS, IDREFS, NMENTITIES.

Parameters

pctxt Pointer to OSCTXT structure

Returns: 0 - if success, negative value is error.

◆ rtSaxStrListParse()

EXTERNXML int rtSaxStrListParse	(	OSCTXT *	pctxt,
		OSRTMEMBUF *	pMemBuf,
		OSRTDList *	pvalue
	)

This function parses the list of strings.

It is used for parsing NMTOKENS, IDREFS, NMENTITIES.

Parameters

pctxt	Pointer to OSCTXT structure. Can be NULL, if pMemBuf is not NULL.
pMemBuf	Pointer to memory buffer structure. Can be NULL, if pctxt is not NULL.
pvalue	Doubly-linked list for parsed strings.

Returns: 0 - if success, negative value is error.

◆ rtXmlCmpBase64Str()

EXTERNXML OSBOOL rtXmlCmpBase64Str	(	OSUINT32	nocts1,
		const OSOCTET *	data1,
		const OSUTF8CHAR *	data2
	)

This function compares an array of octets to a base64 string.

Parameters

nocts1	Number of octets in data1.
data1	Pointer to array of OSOCTET.
data2	Pointer to null-terminated array of OSUTF8CHAR.

Returns: TRUE if data2 is a base64 string representation of data1, false otherwise.

◆ rtXmlCmpHexStr()

EXTERNXML OSBOOL rtXmlCmpHexStr	(	OSUINT32	nocts1,
		const OSOCTET *	data1,
		const OSUTF8CHAR *	data2
	)

This function compares an array of octets to a hex string.

Parameters

nocts1	Number of octets in data1.
data1	Pointer to array of OSOCTET.
data2	Pointer to null-terminated array of OSUTF8CHAR.

Returns: TRUE if data2 is a hex string representation of data1, false otherwise.

◆ rtXmlCreateFileInputSource()

EXTERNXML int rtXmlCreateFileInputSource	(	OSCTXT *	pctxt,
		const char *	filepath
	)

This function creates an XML document file input source.

The document can then be decoded by invoking an XML decode function.

Parameters

pctxt	Pointer to context block structure.
filepath	Full pathname of XML document file to open.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlInitContext()

EXTERNXML int rtXmlInitContext ( OSCTXT * pctxt )

This function initializes a context variable for XML encoding or decoding.

Parameters

pctxt Pointer to OSCTXT structure

◆ rtXmlInitContextUsingKey()

EXTERNXML int rtXmlInitContextUsingKey	(	OSCTXT *	pctxt,
		const OSOCTET *	key,
		OSSIZE	keylen
	)

This function initializes a context using a run-time key.

This form is required for evaluation and limited distribution software. The compiler will generate a macro for rtXmlInitContext in the rtkey.h file that will invoke this function with the generated run-time key.

Parameters

pctxt	The pointer to the context structure variable to be initialized.
key	Key data generated by ASN1C compiler.
keylen	Key data field length.

Returns

Completion status of operation:

0 (ASN_OK) = success,
negative return value is error.

◆ rtXmlInitCtxtAppInfo()

EXTERNXML int rtXmlInitCtxtAppInfo ( OSCTXT * pctxt )

This function initializes the XML application info section of the given context.

Parameters

pctxt Pointer to OSCTXT structure

◆ rtXmlMatchBase64Str()

EXTERNXML int rtXmlMatchBase64Str	(	OSCTXT *	pctxt,
		OSSIZE	minLength,
		OSSIZE	maxLength
	)

This function tests the context buffer for containing a correct base64 string.

It does not decode the value.

Parameters

pctxt	Pointer to OSCTXT structure
minLength	A minimal length of expected string.
maxLength	A maximal length of expected string.

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchDate()

EXTERNXML int rtXmlMatchDate ( OSCTXT * pctxt )

This function tests the context buffer for containing a correct date string.

It does not decode the value.

Parameters

pctxt Pointer to OSCTXT structure

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchDateTime()

EXTERNXML int rtXmlMatchDateTime ( OSCTXT * pctxt )

This function tests the context buffer for containing a correct dateTime string.

It does not decode the value.

Parameters

pctxt Pointer to OSCTXT structure

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchGDay()

EXTERNXML int rtXmlMatchGDay ( OSCTXT * pctxt )

This function tests the context buffer for containing a correct gDay string.

It does not decode the value.

Parameters

pctxt Pointer to OSCTXT structure

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchGMonth()

EXTERNXML int rtXmlMatchGMonth ( OSCTXT * pctxt )

This function tests the context buffer for containing a correct gMonth string.

It does not decode the value.

Parameters

pctxt Pointer to OSCTXT structure

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchGMonthDay()

EXTERNXML int rtXmlMatchGMonthDay ( OSCTXT * pctxt )

This function tests the context buffer for containing a correct gMonthDay string.

It does not decode the value.

Parameters

pctxt Pointer to OSCTXT structure

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchGYear()

EXTERNXML int rtXmlMatchGYear ( OSCTXT * pctxt )

This function tests the context buffer for containing a correct gYear string.

It does not decode the value.

Parameters

pctxt Pointer to OSCTXT structure

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchGYearMonth()

EXTERNXML int rtXmlMatchGYearMonth ( OSCTXT * pctxt )

This function tests the context buffer for containing a correct gYearMonth string.

It does not decode the value.

Parameters

pctxt Pointer to OSCTXT structure

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchHexStr()

EXTERNXML int rtXmlMatchHexStr	(	OSCTXT *	pctxt,
		OSSIZE	minLength,
		OSSIZE	maxLength
	)

This function tests the context buffer for containing a correct hexadecimal string.

It does not decode the value.

Parameters

pctxt	Pointer to OSCTXT structure
minLength	A minimal length of expected string.
maxLength	A maximal length of expected string.

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMatchTime()

EXTERNXML int rtXmlMatchTime ( OSCTXT * pctxt )

This function tests the context buffer for containing a correct time string.

It does not decode the value.

Parameters

pctxt Pointer to OSCTXT structure

Returns: If the string in the context buffer is a correct one, function returns zero. Error code (negative) will be returned otherwise. Note, error record will NOT be added in the error's list of the context.

◆ rtXmlMemFreeAnyAttrs()

EXTERNXML void rtXmlMemFreeAnyAttrs	(	OSCTXT *	pctxt,
		OSRTDList *	pAnyAttrList
	)

This function frees a list of anyAttribute that is a member of OSXSDAnyType structure.

Parameters

pctxt	Pointer to context block structure.
pAnyAttrList	Pointer to list of anyAttribute that is to be freed.

◆ rtXmlNewQName()

EXTERNXML OSUTF8CHAR* rtXmlNewQName	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	localName,
		const OSUTF8CHAR *	prefix
	)

This function creates a new QName given the localName and prefix parts.

Parameters

pctxt	Pointer to a context structure.
localName	Element local name.
prefix	Namespace prefix.

Returns: QName value. Memory for the value will have been allocated by rtxMemAlloc and thus must be freed using one of the rtxMemFree functions. The value will be NULL if no dynamic memory was available.

◆ rtXmlPrepareContext()

EXTERNXML int rtXmlPrepareContext ( OSCTXT * pctxt )

This function prepares the context for another encode by setting the state back to OSXMLINIT and moving the buffer's cursor back to the beginning of the buffer.

Parameters

pctxt Pointer to OSCTXT structure

Returns: 0 if OK, negative status code if error.

◆ rtXmlSetEncC14N()

EXTERNXML int rtXmlSetEncC14N	(	OSCTXT *	pctxt,
		OSBOOL	value
	)

This function sets the option to encode in C14N mode.

Parameters

pctxt	Pointer to OSCTXT structure
value	Boolean value: true = C14N mode enabled.

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetEncDocHdr()

EXTERNXML int rtXmlSetEncDocHdr	(	OSCTXT *	pctxt,
		OSBOOL	value
	)

This function sets the option to add the XML document header (i.e.

<?xml version="1.0" encoding="UTF-8"?>) to the XML output stream.

Parameters

pctxt	Pointer to OSCTXT structure
value	Boolean value: true = add document header

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetEncodingStr()

EXTERNXML int rtXmlSetEncodingStr	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	encodingStr
	)

This function sets the XML output encoding to the given value.

Currently, UTF-8/UTF-16/ISO-8859-1 encodings are supported.

Parameters

pctxt	Pointer to OSCTXT structure
encodingStr	XML output encoding format

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetEncXSINamespace()

EXTERNXML int rtXmlSetEncXSINamespace	(	OSCTXT *	pctxt,
		OSBOOL	value
	)

This function sets a flag in the context that indicates the XSI namespace declaration (xmlns:xsi) should be added to the encoded XML instance.

Parameters

pctxt	Pointer to OSCTXT structure
value	Boolean value: true = encode XSI namespace attribute.

Returns: Status of operation: 0 if OK, negative status code if error.

Referenced by OSXSDGlobalElement::setEncXSINamespace().

◆ rtXmlSetEncXSINilAttr()

EXTERNXML int rtXmlSetEncXSINilAttr	(	OSCTXT *	pctxt,
		OSBOOL	value
	)

This function sets a flag in the context that indicates the XSI attribute declaration (xmlns:xsi) should be added to the encoded XML instance.

Parameters

pctxt	Pointer to OSCTXT structure
value	Boolean value: true = encode xsi:nil attribute.

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetFormatting()

EXTERNXML int rtXmlSetFormatting	(	OSCTXT *	pctxt,
		OSBOOL	doFormatting
	)

This function sets XML output formatting to the given value.

If TRUE (the default), the XML document is formatted with indentation and newlines. If FALSE, all whitespace between elements is suppressed. Turning formatting off can provide more compressed documents and also a more canonical representation which is important for security applications. Also the function 'rtXmlSetIndent' might be used to set the exact size of identation.

Parameters

pctxt	Pointer to OSCTXT structure
doFormatting	Boolean value indicating if formatting is to be done

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetIndent()

EXTERNXML int rtXmlSetIndent	(	OSCTXT *	pctxt,
		OSUINT8	indent
	)

This function sets XML output indent to the given value.

Parameters

pctxt	Pointer to OSCTXT structure
indent	Number of spaces per indent. Default is 3.

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetIndentChar()

EXTERNXML int rtXmlSetIndentChar	(	OSCTXT *	pctxt,
		char	indentChar
	)

This function sets XML output indent character to the given value.

Parameters

pctxt	Pointer to OSCTXT structure
indentChar	Indent character. Default is space.

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetNamespacesSet()

EXTERNXML void rtXmlSetNamespacesSet	(	OSCTXT *	pctxt,
		OSBOOL	value
	)

This function sets the context 'namespaces are set' flag.

This indicates that namespace declarations have been set either by the decoder or externally by the end user. It is used by the encoder to know not to set the default namespaces specified in the schema before starting encoding.

Parameters

pctxt	Pointer to OSCTXT structure.
value	Boolean value to which flag is to be set.

◆ rtXmlSetNoNSSchemaLocation()

EXTERNXML int rtXmlSetNoNSSchemaLocation	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	schemaLocation
	)

This function sets the XML Schema Instance (xsi) no namespace schema location attribute to be added to an encoded document.

This attribute is optional: if not set, no xsi:noNamespaceSchemaLocation attribute will be added.

Parameters

pctxt	Pointer to OSCTXT structure
schemaLocation	Schema location attribute value

Returns: Status of operation: 0 if OK, negative status code if error.

Referenced by OSXSDGlobalElement::setNoNSSchemaLocation().

◆ rtXmlSetNSPrefixLinks()

EXTERNXML int rtXmlSetNSPrefixLinks	(	OSCTXT *	pctxt,
		OSRTDList *	pNSAttrs
	)

This function sets namespace prefix/URI links in the namspace prefix stack in the context structure.

Parameters

pctxt	Pointer to OSCTXT structure.
pNSAttrs	List of namespace attributes.

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetSchemaLocation()

EXTERNXML int rtXmlSetSchemaLocation	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	schemaLocation
	)

This function sets the XML Schema Instance (xsi) schema location attribute to be added to an encoded document.

This attribute is optional: if not set, no xsi:schemaLocation attribute will be added.

Parameters

pctxt	Pointer to OSCTXT structure
schemaLocation	Schema location attribute value

Returns: Status of operation: 0 if OK, negative status code if error.

Referenced by OSXSDGlobalElement::setSchemaLocation().

◆ rtXmlSetSoapVersion()

EXTERNXML void rtXmlSetSoapVersion	(	OSCTXT *	pctxt,
		OSUINT8	version
	)

This function sets the SOAP version number.

Parameters

pctxt	Pointer to OSCTXT structure
version	SOAP version number as 2 digit integer (for example, 11 is SOAP version 1.1, 12 is version 1.2, etc.)

◆ rtXmlSetWriteBOM()

EXTERNXML int rtXmlSetWriteBOM	(	OSCTXT *	pctxt,
		OSBOOL	write
	)

This function sets whether the Unicode byte order mark is encoded.

Parameters

pctxt	Pointer to OSCTXT structure
write	TRUE to encode BOM, FALSE to not encode BOM.

Returns: Status of operation: 0 if OK, negative status code if error.

◆ rtXmlSetXSITypeAttr()

EXTERNXML int rtXmlSetXSITypeAttr	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	xsiType
	)

This function sets the XML Schema Instance (xsi) type attribute value.

This will cause an xsi:type attribute to be added to the top level element in an encoded XML instance.

Parameters

pctxt	Pointer to OSCTXT structure
xsiType	xsi:type attribute value

Returns: Status of operation: 0 if OK, negative status code if error.

Referenced by OSXSDGlobalElement::setXSIType().

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ IS_XMLNSATTR

◆ IS_XSIATTR

◆ OSASN1XER

◆ OSHASDEFAULT

◆ OSXMLC14N

◆ OSXMLQNAMEEQUALS

◆ OSXMLSETUTF8DECPTR

Typedef Documentation

◆ OSXMLGroupDesc

Function Documentation

◆ rtSaxGetAttrValue()

◆ rtSaxGetElemID()

◆ rtSaxGetElemID8()

◆ rtSaxHasXMLNSAttrs()

◆ rtSaxIsEmptyBuffer()

◆ rtSaxSortAttrs()

◆ rtSaxStrListMatch()

◆ rtSaxStrListParse()

◆ rtXmlCmpBase64Str()

◆ rtXmlCmpHexStr()

◆ rtXmlCreateFileInputSource()

◆ rtXmlInitContext()

◆ rtXmlInitContextUsingKey()

◆ rtXmlInitCtxtAppInfo()

◆ rtXmlMatchBase64Str()

◆ rtXmlMatchDate()

◆ rtXmlMatchDateTime()

◆ rtXmlMatchGDay()

◆ rtXmlMatchGMonth()

◆ rtXmlMatchGMonthDay()

◆ rtXmlMatchGYear()

◆ rtXmlMatchGYearMonth()

◆ rtXmlMatchHexStr()

◆ rtXmlMatchTime()

◆ rtXmlMemFreeAnyAttrs()

◆ rtXmlNewQName()

◆ rtXmlPrepareContext()

◆ rtXmlSetEncC14N()

◆ rtXmlSetEncDocHdr()

◆ rtXmlSetEncodingStr()

◆ rtXmlSetEncXSINamespace()

◆ rtXmlSetEncXSINilAttr()

◆ rtXmlSetFormatting()

◆ rtXmlSetIndent()

◆ rtXmlSetIndentChar()

◆ rtXmlSetNamespacesSet()

◆ rtXmlSetNoNSSchemaLocation()

◆ rtXmlSetNSPrefixLinks()

◆ rtXmlSetSchemaLocation()

◆ rtXmlSetSoapVersion()

◆ rtXmlSetWriteBOM()

◆ rtXmlSetXSITypeAttr()