osrtdom.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2003-2007 Objective Systems, Inc.
00003  *
00004  * This software is furnished under a license and may be used and copied
00005  * only in accordance with the terms of such license and with the
00006  * inclusion of the above copyright notice. This software or any other
00007  * copies thereof may not be provided or otherwise made available to any
00008  * other person. No title to and ownership of the software is hereby
00009  * transferred.
00010  *
00011  * The information in this software is subject to change without notice
00012  * and should not be construed as a commitment by Objective Systems, Inc.
00013  *
00014  * PROPRIETARY NOTICE
00015  *
00016  * This software is an unpublished work subject to a confidentiality agreement
00017  * and is protected by copyright and trade secret law.  Unauthorized copying,
00018  * redistribution or other use of this work is prohibited.
00019  *
00020  * The above notice of copyright on this source code product does not indicate
00021  * any actual or intended publication of such source code.
00022  *
00023  *****************************************************************************/
00028 #ifndef _OSRTDOM_H_
00029 #define _OSRTDOM_H_
00030 
00031 #include "rtxsrc/rtxCommon.h"
00032 #include "rtdomsrc/rtxDomDefs.h"
00033 #include "rtxmlsrc/osrtxml.h"
00034 #include "rtdomsrc/domAPI.h"
00035 #include "rtxmlsrc/rtXmlNamespace.h"
00036 
00037 /* This is necessary to disable a Visual C++ warning about an unreferenced
00038    formal parameter passed to the rtDom* functions. */
00039 #ifdef _MSC_VER
00040 #pragma warning(disable: 4100) 
00041 #endif /* _MSC_VER */
00042 
00043 #ifdef __cplusplus
00044 extern "C" {
00045 #endif
00046 
00065 EXTERNDOM int rtDomAddAttr (OSCTXT* pctxt,
00066                             OSRTDOMDocPtr domDoc,
00067                             OSRTDOMNodePtr node,
00068                             const OSUTF8CHAR* attrName,
00069                             OSXMLNamespace* pNS, 
00070                             OSRTDList* pNSAttrs);
00071 
00091 EXTERNDOM int rtDomAddNode (OSCTXT* pctxt, 
00092                             OSRTDOMDocPtr domDoc, 
00093                             OSRTDOMNodePtr parentNode, 
00094                             const OSUTF8CHAR* elemName,
00095                             OSXMLNamespace* pNS, 
00096                             OSRTDList* pNSAttrs);
00097 
00112 EXTERNDOM int rtDomAddNSAttrs 
00113    (OSCTXT* pctxt, OSRTDOMDocPtr domDoc, OSRTDOMNodePtr rootNode,
00114     OSRTDList* pNSAttrs);
00115 
00130 EXTERNDOM int rtDomEncXSIAttrs 
00131    (OSCTXT* pctxt, OSRTDOMDocPtr domDoc, OSRTDOMNodePtr node, 
00132     OSBOOL needXSI);
00133 
00143 EXTERNDOM int rtDomDecodeDoc 
00144    (OSRTDOMDocPtr domDoc, struct OSSAXHandlerBase* pSaxBase);
00145 
00155 EXTERNDOM int rtDomEncStringValue (OSCTXT* pctxt, 
00156                                    const OSUTF8CHAR* pvalue);
00157 
00167 EXTERNDOM int rtDomEncString (OSCTXT* pctxt, OSXMLSTRING* pvalue);
00168 
00187 EXTERNDOM int rtDomEncAny (OSCTXT* pctxt, OSRTDOMDocPtr domDoc, 
00188                            OSRTDOMNodePtr parentNode,
00189                            const OSXMLSTRING* pXmlData,
00190                            const OSUTF8CHAR* elemName,
00191                            OSXMLNamespace* pNS, 
00192                            OSRTDList* pNSAttrs);
00193 
00206 EXTERNDOM int rtDomEncAnyAttr (OSCTXT* pctxt, OSRTDOMDocPtr domDoc, 
00207                                OSRTDOMNodePtr node, OSRTDList* pAnyAttrList);
00208 
00225 EXTERNDOM int rtDomSetNode (OSCTXT* pctxt,
00226                             OSRTDOMDocPtr domDoc,
00227                             OSRTDOMNodePtr curNode);
00228 
00245 EXTERNDOM int rtDomAddSubTree (OSCTXT* pctxt, OSRTDOMDocPtr xmlDoc,
00246                                       OSRTDOMNodePtr node,
00247                                       const OSUTF8CHAR* pXmlData,
00248                                       size_t dataLen);
00249 
00250 
00251 #ifdef __cplusplus
00252 }
00253 #endif
00254 
00255 #endif /* _OSRTDOM_H_ */