Objective Systems, Inc.  
Home
About ASN.1
Products
Free Software
Documents
Services
Resources
Resellers
Customers
Careers
About Us
Contact Us
 

Google


Objective Systems, Inc.

osrtxml.h File Reference

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

#include <setjmp.h>
#include "rtxsrc/rtxCommon.h"
#include "rtxmlsrc/rtSaxDefs.h"
#include "rtxsrc/rtxDList.h"
#include "rtxsrc/rtxMemBuf.h"

Go to the source code of this file.

Classes

struct  OSXMLCtxtInfo
struct  OSXMLQName
struct  OSXMLNamespace

Defines

#define EXTERNXML
#define OSXMLINDENT   3
#define rtXmlErrAddStrParm   rtxErrAddStrParm
#define rtXmlGetEncBufPtr(pctxt)   (pctxt)->buffer.data
 This macro returns the start address of the encoded XML message.

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


Typedefs

typedef OSXMLQName OSXMLQName
typedef OSXMLNamespace OSXMLNamespace

Enumerations

enum  OSXMLEncoding { OSXMLUTF8, OSXMLUTF16 }
enum  OSXMLState { OSXMLINIT, OSXMLSTART, OSXMLDATA, OSXMLEND }

Functions

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

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

OSBOOL rtXmlCmpQName (const XMLCHAR *qname1, const OSUTF8CHAR *name2, const OSUTF8CHAR *nsPrefix2)
int rtXmlDecBase64Binary (OSMemBuf *pMemBuf, const XMLCHAR *inpdata, int length)
 This function decodes the contents of a Base64-encoded binary data type into a memory buffer.

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

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

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

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

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

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

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

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

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

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

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

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

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

int rtXmlDecHexBinary (OSMemBuf *pMemBuf, const XMLCHAR *inpdata, int length)
 This function decodes the contents of a hex-encoded binary data type into a memory buffer.

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

int rtXmlDecHexStrValue (const OSUTF8CHAR *inpdata, OSOCTET *pvalue, OSUINT32 *pnbits, OSINT32 bufsize)
int rtXmlDecInt (OSCTXT *pctxt, OSINT32 *pvalue)
 This function decodes the contents of a 32-bit integer data type.

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

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

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

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

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

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

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

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

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

int rtXmlDecXSIAttrs (OSCTXT *pctxt, const XMLCHAR *const *attrs)
 This function decodes XML schema instance (XSI) attributes.

int rtXmlEncAny (OSCTXT *pctxt, OSAnyElement *pvalue, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a variable of the XSD any type.

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.

int rtXmlEncBase64Binary (OSCTXT *pctxt, OSUINT32 nocts, const OSOCTET *value, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a variable of the XSD base64Binary type.

int rtXmlEncBase64BinaryAttr (OSCTXT *pctxt, OSUINT32 nocts, const OSOCTET *value, const OSUTF8CHAR *attrName, OSUINT16 attrNameLen)
int rtXmlEncBase64StrValue (OSCTXT *pctxt, OSUINT32 nocts, const OSOCTET *value)
int rtXmlEncBigInt (OSCTXT *pctxt, const OSUTF8CHAR *value, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a variable of the XSD integer type.

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

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

int rtXmlEncBoolValue (OSCTXT *pctxt, OSBOOL value)
int rtXmlEncBoolAttr (OSCTXT *pctxt, OSBOOL value, const OSUTF8CHAR *attrName, OSUINT16 attrNameLen)
 This function encodes an XSD boolean attribute value.

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

int rtXmlEncDateValue (OSCTXT *pctxt, OSXSDDateTime *pvalue)
int rtXmlEncTime (OSCTXT *pctxt, OSXSDDateTime *pvalue, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a variable of the XSD 'time' type as an string.

int rtXmlEncTimeValue (OSCTXT *pctxt, OSXSDDateTime *pvalue)
int rtXmlEncDateTime (OSCTXT *pctxt, OSXSDDateTime *pvalue, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a numeric date/time value into an XML string representation.

int rtXmlEncDateTimeValue (OSCTXT *pctxt, OSXSDDateTime *pvalue)
int rtXmlEncDecimal (OSCTXT *pctxt, OSREAL value, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix, int totalDigits, int fractionDigits)
 This function encodes a variable of the XSD decimal type.

int rtXmlEncDecimalAttr (OSCTXT *pctxt, OSREAL value, const OSUTF8CHAR *attrName, OSUINT16 attrNameLen)
int rtXmlEncDouble (OSCTXT *pctxt, OSREAL value, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix, int totalDigits, int fractionDigits)
 This function encodes a variable of the XSD float or double type.

int rtXmlEncDoubleAttr (OSCTXT *pctxt, OSREAL value, const OSUTF8CHAR *attrName, OSUINT16 attrNameLen)
int rtXmlEncEmptyElement (OSCTXT *pctxt, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix, OSBOOL terminate)
 This function encodes an enpty element tag value (<elemName/>).

int rtXmlEncEmptyElement2 (OSCTXT *pctxt, const OSUTF8CHAR *elemName, size_t elemLen, const OSUTF8CHAR *nsPrefix, size_t nsPrefixLen, OSBOOL terminate)
int rtXmlEncEndDocument (OSCTXT *pctxt)
 This function adds trailor information and a null terminator at the end of the XML document being encoded.

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

int rtXmlEncEndElement2 (OSCTXT *pctxt, const OSUTF8CHAR *elemName, size_t elemLen, const OSUTF8CHAR *nsPrefix, size_t nsPrefixLen)
int rtXmlEncEndSoapEnv (OSCTXT *pctxt)
 This function encodes a SOAP envelope end element tag (<SOAP-ENV:Envelope/>).

int rtXmlEncHexBinary (OSCTXT *pctxt, OSUINT32 nocts, const OSOCTET *value, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a variable of the XSD hexBinary type.

int rtXmlEncHexBinaryAttr (OSCTXT *pctxt, OSUINT32 nocts, const OSOCTET *value, const OSUTF8CHAR *attrName, OSUINT16 attrNameLen)
int rtXmlEncHexStrValue (OSCTXT *pctxt, OSUINT32 nocts, const OSOCTET *data)
int rtXmlEncIndent (OSCTXT *pctxt)
 This function adds indentation whitespace to the output stream.

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

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

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

int rtXmlEncIntPatternValue (OSCTXT *pctxt, OSINT32 value, const OSUTF8CHAR *pattern)
int rtXmlEncInt64 (OSCTXT *pctxt, OSINT64 value, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a variable of the XSD integer type.

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

int rtXmlEncNSAttrs (OSCTXT *pctxt)
 This function encodes namespace declaration attributes at the beginning of an XML document.

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

int rtXmlEncSoapArrayTypeAttr2 (OSCTXT *pctxt, const OSUTF8CHAR *name, size_t nameLen, const OSUTF8CHAR *value, size_t valueLen, size_t itemCount)
int rtXmlEncStartDocument (OSCTXT *pctxt)
 This function encodes the XML header text at the beginning of an XML document.

int rtXmlEncStartElement (OSCTXT *pctxt, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix, OSBOOL terminate)
 This function encodes a start element tag value (<elemName>).

int rtXmlEncStartElement2 (OSCTXT *pctxt, const OSUTF8CHAR *elemName, size_t elemLen, const OSUTF8CHAR *nsPrefix, size_t nsPrefixLen, OSBOOL terminate)
int rtXmlEncStartSoapEnv (OSCTXT *pctxt)
 This function encodes a SOAP envelope start element tag.

int rtXmlEncString (OSCTXT *pctxt, OSXMLSTRING *pxmlstr, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a variable of the XSD string type.

int rtXmlEncStringValue (OSCTXT *pctxt, const OSUTF8CHAR *value)
int rtXmlEncUTF8Attr (OSCTXT *pctxt, const OSUTF8CHAR *name, const OSUTF8CHAR *value)
 This function encodes an attribute in which the value is given as a UTF-8 string.

int rtXmlEncUTF8Attr2 (OSCTXT *pctxt, const OSUTF8CHAR *name, size_t nameLen, const OSUTF8CHAR *value, size_t valueLen)
int rtXmlEncUTF8Str (OSCTXT *pctxt, const OSUTF8CHAR *value, const OSUTF8CHAR *elemName, const OSUTF8CHAR *nsPrefix)
 This function encodes a UTF-8 string value.

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

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

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

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

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

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

OSBOOL rtXmlStrCmpAsc (const XMLCHAR *text1, const char *text2)
OSBOOL rtXmlStrnCmpAsc (const XMLCHAR *text1, const char *text2, size_t len)
int rtXmlFinalizeMemBuf (OSMemBuf *pMemBuf)
int rtXmlSetEncBufPtr (OSCTXT *pctxt, OSOCTET *bufaddr, OSUINT32 bufsiz)
 This function is used to set the internal buffer within the run-time library encoding context.

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

int rtXmlSetEncoding (OSCTXT *pctxt, OSXMLEncoding encoding)
 This function sets the XML output encoding to the given value.

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

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.

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.

OSXMLNamespace * rtXmlNSAddNamespace (OSCTXT *pctxt, const OSUTF8CHAR *prefix, const OSUTF8CHAR *uri)
 This function adds a namespace to the context namespace list.

OSXMLNamespace * rtXmlNSLookupURI (OSCTXT *pctxt, const OSUTF8CHAR *uri)
 This function looks up a namespace in the context namespace list using URI as the key value.

void rtXmlNSRemoveAll (OSCTXT *pctxt)
 This function removes all namespaces from the context namespace list and frees the dynamic memory used to hold the names.

OSXMLNamespace * rtXmlNSSetNamespace (OSCTXT *pctxt, const OSUTF8CHAR *prefix, const OSUTF8CHAR *uri, OSBOOL override)
 This function sets a namespace in the context namespace list.

int rtXmlMatchHexStr (OSCTXT *pctxt)
int rtXmlMatchBase64Str (OSCTXT *pctxt)
int rtSaxGetElemID (OSINT16 *pState, const XMLCHAR *localName, const OSSAXElemTableRec idtab[], const int *fstab, int fstabRows, int fstabCols)
 This function looks up a sequence element name in the given element info array.

int rtSaxGetElemID8 (OSINT16 *pState, const XMLCHAR *localName, const OSSAXElemTableRec idtab[], const OSINT8 *fstab, int fstabRows, int fstabCols)
 This function is a space optimized version of rtSaxGetElemID.

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

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


Detailed Description

XML low-level C encode/decode functions.

Definition in file osrtxml.h.


Function Documentation

int rtSaxGetElemID OSINT16 *  pState,
const XMLCHAR *  localName,
const OSSAXElemTableRec  idtab[],
const int *  fstab,
int  fstabRows,
int  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.
localName Local name of XML element
idtab Element ID table
fstab Finite state table
fstabRows Number of rows in fstab.
fstabCols Number of columns in fstab.

int rtSaxGetElemID8 OSINT16 *  pState,
const XMLCHAR *  localName,
const OSSAXElemTableRec  idtab[],
const OSINT8 *  fstab,
int  fstabRows,
int  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.
localName Local name of XML element
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.

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.

int rtSaxStrListParse OSCTXT pctxt,
OSMemBuf *  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.

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.

int rtXmlInitContext OSCTXT pctxt  ) 
 

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

Parameters:
pctxt Pointer to OSCTXT structure

OSXMLNamespace* rtXmlNSAddNamespace OSCTXT pctxt,
const OSUTF8CHAR *  prefix,
const OSUTF8CHAR *  uri
 

This function adds a namespace to the context namespace list.

Parameters:
pctxt Pointer to OSCTXT structure
prefix Namespace prefix to be added
uri Namespace URI to be added
Returns:
Pointer to namespace structure or NULL if not added.

OSXMLNamespace* rtXmlNSLookupURI OSCTXT pctxt,
const OSUTF8CHAR *  uri
 

This function looks up a namespace in the context namespace list using URI as the key value.

Parameters:
pctxt Pointer to OSCTXT structure
uri Namespace URI to be found.
Returns:
Pointer to namespace structure or NULL if not found.

void rtXmlNSRemoveAll OSCTXT pctxt  ) 
 

This function removes all namespaces from the context namespace list and frees the dynamic memory used to hold the names.

Parameters:
pctxt Pointer to OSCTXT structure

OSXMLNamespace* rtXmlNSSetNamespace OSCTXT pctxt,
const OSUTF8CHAR *  prefix,
const OSUTF8CHAR *  uri,
OSBOOL  override
 

This function sets a namespace in the context namespace list.

If the given namespace URI does not exist in the list, the namespace is added. If the URI is found, the action depends on the value of the override flag. If true, the value of the namespace prefix will be changed to the given prefix. If false, the existing namespace specification is not altered.

Parameters:
pctxt Pointer to OSCTXT structure
prefix Namespace prefix
uri Namespace URI
override Should existing definition be changed?
Returns:
Pointer to namespace structure or NULL if not set.

int rtXmlParseElementName OSCTXT pctxt,
OSUTF8CHAR **  ppName
 

This function parses initial tag from an XML message.

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.

int rtXmlSetEncoding OSCTXT pctxt,
OSXMLEncoding  encoding
 

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

Currently, only UTF-8 encoding is supported.

Parameters:
pctxt Pointer to OSCTXT structure
encoding XML output encoding format (UTF-8 or UTF-16)

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.

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

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

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


This file was last modified on 1 Jun 2004.
XBinder, Version 1.0.0