Class Hierarchy   Class Index   Method Index  

DLLuntypedMessageTree.h

00001 #ifndef __DLL_UNTYPED_MESSAGE_TREE_H__
00002 #define __DLL_UNTYPED_MESSAGE_TREE_H__
00003 
00004 //---------------------------------------------------------------------------
00005 // Module: DLLuntypedMessageTree
00006 //
00007 // Description:
00008 //
00009 // This is a thin interface class to the real underlying CHMuntypedMessageTree
00010 // class.  
00011 //
00012 //---------------------------------------------------------------------------
00013 
00014 #include <CHM/CHMminimumInclude.h>
00015 #include <CHM/CHMdataType.h>
00016 
00017 typedef void* CHMuntypedMessageTreeHandle;
00018 typedef void* CHMconfigHandle;
00019 
00020 CHM_DLL_FUNC(CHMuntypedMessageTreeCreate)
00021 (
00022    CHMuntypedMessageTreeHandle* Handle
00023 );
00024 
00025 CHM_DLL_FUNC(CHMuntypedMessageTreeAddRef)
00026 (
00027    CHMuntypedMessageTreeHandle Handle
00028 );
00029 
00030 CHM_DLL_FUNC(CHMuntypedMessageTreeRelease)
00031 (
00032    CHMuntypedMessageTreeHandle Handle
00033 );
00034 
00035 CHM_DLL_FUNC(CHMuntypedMessageTreeIsNode)
00036 (
00037    CHMuntypedMessageTreeHandle Handle,
00038    short*                      IsNode
00039 );
00040 
00041 CHM_DLL_FUNC(CHMuntypedMessageTreeSubNode)
00042 (
00043    CHMuntypedMessageTreeHandle  Handle,
00044    unsigned long                SubNodeIndex,
00045    unsigned long                RepeatNodeIndex,
00046    CHMuntypedMessageTreeHandle* pSubNode
00047 );
00048 
00049 CHM_DLL_FUNC(CHMuntypedMessageTreeCountOfSubNode)
00050 (
00051    CHMuntypedMessageTreeHandle Handle,
00052    unsigned long*              pCountOfSubNode
00053 );
00054 
00055 CHM_DLL_FUNC(CHMuntypedMessageTreeGetValue)
00056 (
00057    CHMuntypedMessageTreeHandle Handle,
00058    const CHMchar**             ppValue
00059 );
00060 
00061 CHM_DLL_FUNC(CHMuntypedMessageTreeSetValue)
00062 (
00063    CHMuntypedMessageTreeHandle Handle,
00064    const CHMchar*              pValue
00065 );
00066 
00067 CHM_DLL_FUNC(CHMuntypedMessageTreeGetLabel)
00068 (
00069    CHMuntypedMessageTreeHandle Handle,
00070    const CHMchar**             ppLabel
00071 );
00072 
00073 CHM_DLL_FUNC(CHMuntypedMessageTreeSetLabel)
00074 (
00075    CHMuntypedMessageTreeHandle Handle,
00076    const CHMchar*              pValue
00077 );
00078 
00079 CHM_DLL_FUNC(CHMuntypedMessageTreeIsNull)
00080 (
00081    CHMuntypedMessageTreeHandle Handle,
00082    short*                        pIsNull
00083 );
00084 
00085 CHM_DLL_FUNC(CHMuntypedMessageTreeCountOfRepeat)
00086 (
00087    CHMuntypedMessageTreeHandle Handle,
00088    unsigned long*             pCountOfRepeat
00089 );
00090 
00091 CHM_DLL_FUNC(CHMuntypedMessageTreeGetRepeatedNode)
00092 (
00093    CHMuntypedMessageTreeHandle Handle,
00094    unsigned long               RepeatIndex,
00095    CHMuntypedMessageTreeHandle* pRepeatedNode
00096 );
00097 
00098 CHM_DLL_FUNC(CHMuntypedMessageTreeDump)
00099 (
00100    CHMuntypedMessageTreeHandle Handle,
00101    char**                   pDumpBuffer
00102 );
00103 
00104 CHM_DLL_FUNC(CHMuntypedMessageTreeFreeBuffer)
00105 (
00106    char* pBuffer
00107 );
00108 
00109 
00110 CHM_DLL_FUNC(CHMuntypedMessageTreeCountOfError)
00111 (
00112    CHMuntypedMessageTreeHandle Handle,
00113    unsigned long*             pCountOfError
00114 );
00115 
00116 CHM_DLL_FUNC(CHMuntypedMessageTreeErrorDescription)
00117 (
00118    CHMuntypedMessageTreeHandle Handle,
00119    long Index,
00120    CHMchar** pValue
00121 ); 
00122 
00123 CHM_DLL_FUNC(CHMuntypedMessageTreeErrorCode)
00124 (
00125    CHMuntypedMessageTreeHandle Handle,
00126    long  Index,
00127    long* pValue
00128 ); 
00129 
00130 CHM_DLL_FUNC(CHMuntypedMessageTreeFlatwire)
00131 (
00132    CHMuntypedMessageTreeHandle Handle,
00133    long            Level,
00134    CHMconfigHandle ConfigHandle,
00135    CHMchar*        pBuffer,
00136    unsigned long   SizeOfBuffer,
00137    unsigned long*  pCountAvailable
00138 );
00139 
00140 CHM_DLL_FUNC(CHMuntypedMessageTreeClearErrors)
00141 (
00142    CHMuntypedMessageTreeHandle Handle
00143 );
00144 
00145 #endif // end of defensive include