Functions
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...

Detailed Description

Function Documentation

◆ rtXmlDecBase64Binary()

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.

Input is expected to be a string of UTF-8 characters returned by an XML parser. The decoded data will be put into the memory buffer starting from the current position and bit offset. After all data is decoded the octet string may be fetched out.

This function is normally used in the 'characters' SAX handler.

Parameters

pMemBuf	Memory buffer to which decoded binary data is to be appended.
inpdata	Pointer to a source string to be decoded.
length	Length of the source string (in characters).

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecBase64Str()

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.

The octet string must be Base64 encoded. This function call is used to decode a sized base64Binary string production.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a variable to receive the decoded bit string. This is assumed to be a static array large enough to hold the number of octets specified in the bufsize input parameter.
pnocts	A pointer to an integer value to receive the decoded number of octets.
bufsize	The size (in octets) of the sized octet string. An error will occur if the number of octets in the decoded string is larger than this value.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecBase64Str64()

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.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a variable to receive the decoded bit string. This is assumed to be a static array large enough to hold the number of octets specified in the bufsize input parameter.
pnocts	A pointer to an integer value to receive the decoded number of octets.
bufsize	The size (in octets) of the sized octet string. An error will occur if the number of octets in the decoded string is larger than this value.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecBase64StrValue()

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.

The octet string must be Base64 encoded. This function call is used internally to decode both sized and non-sized base64binary string production.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a variable to receive the decoded bit string. This is assumed to be a static array large enough to hold the number of octets specified in the bufsize input parameter.
pnocts	A pointer to an integer value to receive the decoded number of octets.
bufSize	A maximum size (in octets) of `pvalue` buffer. An error will occur if the number of octets in the decoded string is larger than this value.
srcDataLen	An actual source data length (in octets) without whitespaces.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecBase64StrValue64()

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.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a variable to receive the decoded bit string. This is assumed to be a static array large enough to hold the number of octets specified in the bufsize input parameter.
pnocts	A pointer to an integer value to receive the decoded number of octets.
bufSize	A maximum size (in octets) of `pvalue` buffer. An error will occur if the number of octets in the decoded string is larger than this value.
srcDataLen	An actual source data length (in octets) without whitespaces.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecBigInt()

EXTERNXML int rtXmlDecBigInt	(	OSCTXT *	pctxt,
		const OSUTF8CHAR **	ppvalue
	)

This function will decode a variable of the XSD integer type.

In this case, the integer is assumed to be of a larger size than can fit in a C or C++ long type (normally 32 or 64 bits). For example, parameters used to calculate security values are typically larger than these sizes.

These variables are stored in character string constant variables. The radix should be 10. If it is necessary to convert to another radix, then use rtxBigIntSetStr or rtxBigIntToString functions.

Parameters

pctxt	Pointer to context block structure.
ppvalue	Pointer to a pointer to receive decoded UTF-8 string. Dynamic memory is allocated for the variable using the rtMemAlloc function. The decoded variable is represented as a string starting with appropriate prefix.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecBool()

EXTERNXML int rtXmlDecBool	(	OSCTXT *	pctxt,
		OSBOOL *	pvalue
	)

This function decodes a variable of the boolean type.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to a variable to receive the decoded boolean value.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDate()

EXTERNXML int rtXmlDecDate	(	OSCTXT *	pctxt,
		OSXSDDateTime *	pvalue
	)

This function decodes a variable of the XSD 'date' type.

Input is expected to be a string of characters returned by an XML parser. The string should have CCYY-MM-DD format.

Parameters

pctxt	Pointer to context block structure.
pvalue	OSXSDDateTime type pointer points to a OSXSDDateTime value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDateTime()

EXTERNXML int rtXmlDecDateTime	(	OSCTXT *	pctxt,
		OSXSDDateTime *	pvalue
	)

This function decodes a variable of the XSD 'dateTime' type.

Input is expected to be a string of characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	OSXSDDateTime type pointer points to a OSXSDDateTime value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDecimal()

EXTERNXML int rtXmlDecDecimal	(	OSCTXT *	pctxt,
		OSREAL *	pvalue
	)

This function decodes the contents of a decimal data type.

Input is expected to be a string of characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to 64-bit double value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDouble()

EXTERNXML int rtXmlDecDouble	(	OSCTXT *	pctxt,
		OSREAL *	pvalue
	)

This function decodes the contents of a float or double data type.

Input is expected to be a string of characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to 64-bit double value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDynBase64Str()

EXTERNXML int rtXmlDecDynBase64Str	(	OSCTXT *	pctxt,
		OSDynOctStr *	pvalue
	)

This function decodes a contents of a Base64-encode binary string.

The octet string must be Base64 encoded. This function will allocate dynamic memory to store the decoded result.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a dynamic octet string structure to receive the decoded octet string. Dynamic memory is allocated to hold the string using the ::rtxMemAlloc function.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDynBase64Str64()

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.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a dynamic octet string structure to receive the decoded octet string. Dynamic memory is allocated to hold the string using the ::rtxMemAlloc function.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDynHexStr()

EXTERNXML int rtXmlDecDynHexStr	(	OSCTXT *	pctxt,
		OSDynOctStr *	pvalue
	)

This function decodes a contents of a hexBinary string.

This function will allocate dynamic memory to store the decoded result.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a dynamic octet string structure to receive the decoded octet string. Dynamic memory is allocated to hold the string using the ::rtxMemAlloc function.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDynHexStr64()

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.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a dynamic octet string structure to receive the decoded octet string. Dynamic memory is allocated to hold the string using the ::rtxMemAlloc function.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecDynUTF8Str()

EXTERNXML int rtXmlDecDynUTF8Str	(	OSCTXT *	pctxt,
		const OSUTF8CHAR **	outdata
	)

This function decodes the contents of a UTF-8 string data type.

Input is expected to be a string of UTF-8 or Unicode characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
outdata	Pointer to a pointer to receive decoded UTF-8 string. Memory is allocated for this string using the run-time memory manager.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecEmptyElement()

EXTERNXML int rtXmlDecEmptyElement ( OSCTXT * pctxt )

This function is used to enforce a requirement that an element be empty.

An error is returned in the current element has any element or character children. The last event must be the start tag.

Parameters

pctxt A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecGDay()

EXTERNXML int rtXmlDecGDay	(	OSCTXT *	pctxt,
		OSXSDDateTime *	pvalue
	)

This function decodes a variable of the XSD 'gDay' type.

Input is expected to be a string of characters returned by an XML parser. The string should have —DD[-+hh:mm|Z] format.

Parameters

pctxt	Pointer to context block structure.
pvalue	OSXSDDateTime type pointer points to a OSXSDDateTime value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecGMonth()

EXTERNXML int rtXmlDecGMonth	(	OSCTXT *	pctxt,
		OSXSDDateTime *	pvalue
	)

This function decodes a variable of the XSD 'gMonth' type.

Input is expected to be a string of characters returned by an XML parser. The string should have –MM[-+hh:mm|Z] format.

Parameters

pctxt	Pointer to context block structure.
pvalue	OSXSDDateTime type pointer points to a OSXSDDateTime value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecGMonthDay()

EXTERNXML int rtXmlDecGMonthDay	(	OSCTXT *	pctxt,
		OSXSDDateTime *	pvalue
	)

This function decodes a variable of the XSD 'gMonthDay' type.

Input is expected to be a string of characters returned by an XML parser. The string should have –MM-DD[-+hh:mm|Z] format.

Parameters

pctxt	Pointer to context block structure.
pvalue	OSXSDDateTime type pointer points to a OSXSDDateTime value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecGYear()

EXTERNXML int rtXmlDecGYear	(	OSCTXT *	pctxt,
		OSXSDDateTime *	pvalue
	)

This function decodes a variable of the XSD 'gYear' type.

Input is expected to be a string of characters returned by an XML parser. The string should have CCYY[-+hh:mm|Z] format.

Parameters

pctxt	Pointer to context block structure.
pvalue	OSXSDDateTime type pointer points to a OSXSDDateTime value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecGYearMonth()

EXTERNXML int rtXmlDecGYearMonth	(	OSCTXT *	pctxt,
		OSXSDDateTime *	pvalue
	)

This function decodes a variable of the XSD 'gYearMonth' type.

Input is expected to be a string of characters returned by an XML parser. The string should have CCYY-MM[-+hh:mm|Z] format.

Parameters

pctxt	Pointer to context block structure.
pvalue	OSXSDDateTime type pointer points to a OSXSDDateTime value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecHexBinary()

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.

Input is expected to be a string of UTF-8 characters returned by an XML parser. The decoded data will be put into the given memory buffer starting from the current position and bit offset. After all data is decoded the octet string may be fetched out.

This function is normally used in the 'characters' SAX handler.

Parameters

pMemBuf	Pointer to memory buffer onto which the decoded binary data will be appended.
inpdata	Pointer to a source string to be decoded.
length	Length of the source string (in characters).

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecHexStr()

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.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a variable to receive the decoded bit string. This is assumed to be a static array large enough to hold the number of octets specified in the bufsize input parameter.
pnocts	A pointer to an integer value to receive the decoded number of octets.
bufsize	The size (in octets) of the sized octet string. An error will occur if the number of octets in the decoded string is larger than this value.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecHexStr64()

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.

Parameters

pctxt	A pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
pvalue	A pointer to a variable to receive the decoded bit string. This is assumed to be a static array large enough to hold the number of octets specified in the bufsize input parameter.
pnocts	A pointer to an integer value to receive the decoded number of octets.
bufsize	The size (in octets) of the sized octet string. An error will occur if the number of octets in the decoded string is larger than this value.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecInt()

EXTERNXML int rtXmlDecInt	(	OSCTXT *	pctxt,
		OSINT32 *	pvalue
	)

This function decodes the contents of a 32-bit integer data type.

Input is expected to be a string of OSUTF8CHAR characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to 32-bit integer value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecInt16()

EXTERNXML int rtXmlDecInt16	(	OSCTXT *	pctxt,
		OSINT16 *	pvalue
	)

This function decodes the contents of a 16-bit integer data type.

Input is expected to be a string of OSUTF8CHAR characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to 16-bit integer value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecInt64()

EXTERNXML int rtXmlDecInt64	(	OSCTXT *	pctxt,
		OSINT64 *	pvalue
	)

This function decodes the contents of a 64-bit integer data type.

Input is expected to be a string of OSUTF8CHAR characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to 64-bit integer value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecInt8()

EXTERNXML int rtXmlDecInt8	(	OSCTXT *	pctxt,
		OSINT8 *	pvalue
	)

This function decodes the contents of an 8-bit integer data type (i.e.

a signed byte type in the range of -128 to 127). Input is expected to be a string of OSUTF8CHAR characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to 8-bit integer value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecNSAttr()

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).

It is assumed that the given attribute name is either 'xmlns' or 'xmlns:prefix'. The XML namespace prefix and URI are added to the given attribute list structure. The parsed namespace is also added to the namespace stack in the given context.

Parameters

pctxt	Pointer to context structure.
attrName	Name of the XML namespace attribute. This is assumed to contain either 'xmlns' (a default namespace declaration) or 'xmlns:prefix' where prefix is a namespace prefix.
attrValue	XML namespace attribute value (a URI).
pNSAttrs	List to receive parsed namespace values.
nsTable	Namespace URI's parsed from schema.
nsTableRowCount	Number of rows (URI's) in namespace table.

Returns: Zero if success or negative error code.

◆ rtXmlDecQName()

EXTERNXML const OSUTF8CHAR* rtXmlDecQName	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	qname,
		const OSUTF8CHAR **	prefix
	)

This function decodes an XML qualified name string (QName) type.

This is a type that contains an optional namespace prefix followed by a colon and the local part of the name:

[NS 5] QName ::= (Prefix ':')? LocalPart

[NS 6] Prefix ::= NCName

[NS 7] LocalPart ::= NCName

Parameters

pctxt	Pointer to context block structure.
qname	String containing XML QName to be decoded.
prefix	Pointer to string pointer to receive decoded prefix. This is optional. If NULL, the prefix will not be returned. If not-NULL, the prefix will be returned in memory allocated using `rtxMemAlloc` which must be freed using one of the `rtxMemFree` functions.

Returns: Pointer to local part of string. This is pointer to a location within the given string (i.e. a pointer to the character after the ':' or to the beginning of the string if it contains no colon). This pointer does not need to be freed.

◆ rtXmlDecTime()

EXTERNXML int rtXmlDecTime	(	OSCTXT *	pctxt,
		OSXSDDateTime *	pvalue
	)

This function decodes a variable of the XSD 'time' type.

Input is expected to be a string of characters returned by an XML parser. The string should have one of following formats:

               (1) hh-mm-ss.ss  used if tz_flag = false
               (2) hh-mm-ss.ssZ used if tz_flag = false and tzo = 0
               (3) hh-mm-ss.ss+HH:MM if tz_flag = false and tzo > 0
               (4) hh-mm-ss.ss-HH:MM-HH:MM
                                     if tz_flag = false and tzo < 0

Parameters

pctxt	Pointer to context block structure.
pvalue	OSXSDDateTime type pointer points to a OSXSDDateTime value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecUInt()

EXTERNXML int rtXmlDecUInt	(	OSCTXT *	pctxt,
		OSUINT32 *	pvalue
	)

This function decodes the contents of an unsigned 32-bit integer data type.

Input is expected to be a string of OSUTF8CHAR characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to unsigned 32-bit integer value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecUInt16()

EXTERNXML int rtXmlDecUInt16	(	OSCTXT *	pctxt,
		OSUINT16 *	pvalue
	)

This function decodes the contents of an unsigned 16-bit integer data type.

Input is expected to be a string of OSUTF8CHAR characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to unsigned 16-bit integer value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecUInt64()

EXTERNXML int rtXmlDecUInt64	(	OSCTXT *	pctxt,
		OSUINT64 *	pvalue
	)

This function decodes the contents of an unsigned 64-bit integer data type.

Input is expected to be a string of OSUTF8CHAR characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to unsigned 64-bit integer value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecUInt8()

EXTERNXML int rtXmlDecUInt8	(	OSCTXT *	pctxt,
		OSUINT8 *	pvalue
	)

This function decodes the contents of an unsigned 8-bit integer data type (i.e.

a signed byte type in the range of 0 to 255). Input is expected to be a string of OSUTF8CHAR characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to unsigned 8-bit integer value to receive decoded result.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecUTF8Str()

EXTERNXML int rtXmlDecUTF8Str	(	OSCTXT *	pctxt,
		OSUTF8CHAR *	outdata,
		OSSIZE	max_len
	)

This function decodes the contents of a UTF-8 string data type.

Input is expected to be a string of UTF-8 or Unicode characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
outdata	Pointer to a block of memory to receive decoded UTF8 string.
max_len	Size of memory block.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecXmlStr()

EXTERNXML int rtXmlDecXmlStr	(	OSCTXT *	pctxt,
		OSXMLSTRING *	outdata
	)

This function decodes the contents of an XML string data type.

This type contains a pointer to a UTF-8 characer string plus flags that can be set to alter the encoding of the string (for example, the cdata flag allows the string to be encoded in a CDATA section). Input is expected to be a string of UTF-8 characters returned by an XML parser.

Parameters

pctxt	Pointer to context block structure.
outdata	Pointer to an XML string structure to receive the decoded string. Memory is allocated for the string using the run-time memory manager.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecXSIAttr()

EXTERNXML int rtXmlDecXSIAttr	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	attrName,
		const OSUTF8CHAR *	attrValue
	)

This function decodes XML schema instance (XSI) attribute.

These attributes include the XSI namespace declaration, the XSD schema location attribute, and the XSD no namespace schema location attribute.

Parameters

pctxt	Pointer to context block structure.
attrName	Attribute's name to be decoded
attrValue	Attribute's value to be decoded

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlDecXSIAttrs()

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

This function decodes XML schema instance (XSI) attributes.

These attributes include the XSI namespace declaration, the XSD schema location attribute, and the XSD no namespace schema location attribute.

Parameters

pctxt	Pointer to context block structure.
attrs	Attributes-values array [attr, value]. Should be null-terminated.
typeName	Name of parent type to add in error log, if would be necessary.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlParseElementName()

EXTERNXML int rtXmlParseElementName	(	OSCTXT *	pctxt,
		OSUTF8CHAR **	ppName
	)

This function parses the initial tag from an XML message.

If the tag is a QName, only the local part of the name is returned.

Parameters

pctxt	Pointer to OSCTXT structure
ppName	Pointer to a pointer to receive decoded UTF-8 string. Dynamic memory is allocated for the variable using the rtxMemAlloc function.

Returns

Completion status of operation:

0 = success,
negative return value is error.

◆ rtXmlParseElemQName()

EXTERNXML int rtXmlParseElemQName	(	OSCTXT *	pctxt,
		OSXMLQName *	pQName
	)

This function parses the initial tag from an XML message.

Parameters

pctxt	Pointer to OSCTXT structure
pQName	Pointer to a QName structure to receive parsed name prefix and local name. Dynamic memory is allocated for both name parts using the rtxMemAlloc function.

Returns

Completion status of operation:

0 = success,
negative return value is error.

Functions

Detailed Description

Function Documentation

◆ rtXmlDecBase64Binary()

◆ rtXmlDecBase64Str()

◆ rtXmlDecBase64Str64()

◆ rtXmlDecBase64StrValue()

◆ rtXmlDecBase64StrValue64()

◆ rtXmlDecBigInt()

◆ rtXmlDecBool()

◆ rtXmlDecDate()

◆ rtXmlDecDateTime()

◆ rtXmlDecDecimal()

◆ rtXmlDecDouble()

◆ rtXmlDecDynBase64Str()

◆ rtXmlDecDynBase64Str64()

◆ rtXmlDecDynHexStr()

◆ rtXmlDecDynHexStr64()

◆ rtXmlDecDynUTF8Str()

◆ rtXmlDecEmptyElement()

◆ rtXmlDecGDay()

◆ rtXmlDecGMonth()

◆ rtXmlDecGMonthDay()

◆ rtXmlDecGYear()

◆ rtXmlDecGYearMonth()

◆ rtXmlDecHexBinary()

◆ rtXmlDecHexStr()

◆ rtXmlDecHexStr64()

◆ rtXmlDecInt()

◆ rtXmlDecInt16()

◆ rtXmlDecInt64()

◆ rtXmlDecInt8()

◆ rtXmlDecNSAttr()

◆ rtXmlDecQName()

◆ rtXmlDecTime()

◆ rtXmlDecUInt()

◆ rtXmlDecUInt16()

◆ rtXmlDecUInt64()

◆ rtXmlDecUInt8()

◆ rtXmlDecUTF8Str()

◆ rtXmlDecXmlStr()

◆ rtXmlDecXSIAttr()

◆ rtXmlDecXSIAttrs()

◆ rtXmlParseElementName()

◆ rtXmlParseElemQName()