Class Hierarchy   Class Index   Method Index  

CHMconfigDll.h

00001 #ifndef __CHM_CONFIG_DLL_H__
00002 #define __CHM_CONFIG_DLL_H__
00003 //---------------------------------------------------------------------------
00004 // Copyright (C) 1997-2005 iNTERFACEWARE Inc.  All Rights Reserved
00005 //
00006 // Module: CHMconfigDll
00007 //
00008 // Description:
00009 //
00010 //
00011 // Author: Eliot Muir
00012 // Revision: $Revision: 1.9 $
00013 //
00014 // Last Edit Date: $Date: 2006-10-19 23:19:35 $
00015 // Source: $Source: /home/cvs/cvsroot/CHM/CHMconfigDll.h,v $
00016 //---------------------------------------------------------------------------
00017 
00018 #include <CHM/CHMminimumInclude.h>
00019 // CHM_DLL_FUNC(CHMresult) code equals zero for success
00020 
00021 CHM_DLL_FUNC(CHMconfigDump)
00022 (
00023    CHMconfigHandle  Handle,
00024    CHMchar**        ppDumpString
00025 );
00026 
00027 CHM_DLL_FUNC(CHMconfigGetOutputTrailingSeparators)
00028 (
00029    CHMconfigHandle Handle,
00030    size_t*         pOutputTrailingSeparators
00031 );
00032 
00033 CHM_DLL_FUNC(CHMconfigSetOutputTrailingSeparators)
00034 (
00035    CHMconfigHandle Handle,
00036    size_t          OutputTrailingSeparators
00037 );
00038 
00039 CHM_DLL_FUNC(CHMconfigSetEscapeChar)
00040 (
00041    CHMconfigHandle Handle,
00042    CHMchar         EscapeChar
00043 );
00044 
00045 CHM_DLL_FUNC(CHMconfigGetEscapeChar)
00046 (
00047    CHMconfigHandle Handle,
00048    CHMchar*          pEscapeChar
00049 );
00050 
00051 CHM_DLL_FUNC(CHMconfigGetCountOfLevel)
00052 (
00053    CHMconfigHandle Handle,
00054    size_t*         pCountOfLevel
00055 );
00056 
00057 CHM_DLL_FUNC(CHMconfigGetSepChar)
00058 (
00059    CHMconfigHandle Handle,
00060    size_t          CharIndex,
00061    CHMchar*          pSepChar
00062 );
00063 
00064 CHM_DLL_FUNC(CHMconfigSetSepChar)
00065 (
00066    CHMconfigHandle Handle,
00067    size_t          CharIndex,
00068    CHMchar         SepChar
00069 );
00070 
00071 CHM_DLL_FUNC(CHMconfigGetRepeatChar)
00072 (
00073    CHMconfigHandle Handle,
00074    size_t          CharIndex,
00075    size_t*          pRepeatChar
00076 );
00077 
00078 CHM_DLL_FUNC(CHMconfigSetRepeatChar)
00079 (
00080    CHMconfigHandle Handle,
00081    size_t          CharIndex,
00082    size_t           RepeatChar
00083 );
00084 
00085 CHM_DLL_FUNC(CHMconfigGetEscapedRepeatChar)
00086 (
00087    CHMconfigHandle Handle,
00088    size_t          CharIndex,
00089    size_t*        pEscapedChar
00090 );
00091 
00092 CHM_DLL_FUNC(CHMconfigSetEscapedRepeatChar)
00093 (
00094    CHMconfigHandle Handle,
00095    size_t          CharIndex,
00096    size_t           EscapedChar
00097 );
00098 
00099 CHM_DLL_FUNC(CHMconfigGetSepEscapedChar)
00100 (
00101    CHMconfigHandle Handle,
00102    size_t          CharIndex,
00103    size_t*          pEscapedChar
00104 );
00105 
00106 CHM_DLL_FUNC(CHMconfigSetSepEscapedChar)
00107 (
00108    CHMconfigHandle Handle,
00109    size_t          CharIndex,
00110    size_t           EscapedChar
00111 );
00112 
00113 CHM_DLL_FUNC(CHMconfigGetSepCharPosition)
00114 (
00115    CHMconfigHandle Handle,
00116    size_t          CharIndex,
00117    size_t*         pPosition
00118 );
00119 
00120 CHM_DLL_FUNC(CHMconfigSetSepCharPosition)
00121 (
00122    CHMconfigHandle Handle,
00123    size_t          CharIndex,
00124    size_t          Position
00125 );
00126 
00127 CHM_DLL_FUNC(CHMconfigGetRepeatCharPosition)
00128 (
00129    CHMconfigHandle Handle,
00130    size_t          CharIndex,
00131    size_t*         pPosition
00132 );
00133 
00134 CHM_DLL_FUNC(CHMconfigSetRepeatCharPosition)
00135 (
00136    CHMconfigHandle Handle,
00137    size_t          CharIndex,
00138    size_t          Position
00139 );
00140 
00141 CHM_DLL_FUNC(CHMconfigGetEscapeCharEscaped)
00142 (
00143    CHMconfigHandle Handle,
00144    size_t*          pChar
00145 );
00146 
00147 CHM_DLL_FUNC(CHMconfigSetEscapeCharEscaped)
00148 (
00149    CHMconfigHandle Handle,
00150    size_t           Char
00151 );
00152 
00153 CHM_DLL_FUNC(CHMconfigGetEscapeCharPosition)
00154 (
00155    CHMconfigHandle Handle,
00156    size_t*           pPosition
00157 );
00158 
00159 CHM_DLL_FUNC(CHMconfigSetEscapeCharPosition)
00160 (
00161    CHMconfigHandle Handle,
00162    size_t            Position
00163 );
00164 
00165 CHM_DLL_FUNC(CHMconfigGetHeaderSegment)
00166 (
00167    CHMconfigHandle Handle,
00168    const CHMchar**       ppHeaderSegment
00169 );
00170 
00171 CHM_DLL_FUNC(CHMconfigSetHeaderSegment)
00172 (
00173    CHMconfigHandle Handle,
00174    const CHMchar*        pHeaderSegment
00175 );
00176 
00177 CHM_DLL_FUNC(CHMconfigGetStubFileDir)
00178 (
00179    CHMconfigHandle Handle,
00180    const CHMchar**       ppStubFileDir
00181 );
00182 
00183 CHM_DLL_FUNC(CHMconfigSetStubFileDir)
00184 (
00185    CHMconfigHandle Handle,
00186    const CHMchar*        pStubFileDir
00187 );
00188 
00189 CHM_DLL_FUNC(CHMconfigGetStubFileLanguage)
00190 (
00191    CHMconfigHandle Handle,
00192    const CHMchar**       ppStubFileLanguage
00193 );
00194 
00195 CHM_DLL_FUNC(CHMconfigGetDefaultHeader)
00196 (
00197    CHMconfigHandle Handle,
00198    const CHMchar**       ppDefaultHeader
00199 );
00200 
00201 CHM_DLL_FUNC(CHMconfigGetParseSeparatorChars)
00202 (
00203    CHMconfigHandle Handle,
00204    size_t*         pParseSeparatorChars
00205 );
00206 
00207 CHM_DLL_FUNC(CHMconfigSetParseSeparatorChars)
00208 (
00209    CHMconfigHandle Handle,
00210    size_t          ParseSeparatorChars
00211 );
00212 
00213 CHM_DLL_FUNC(CHMconfigAddSepCharAt)
00214 (
00215    CHMconfigHandle Handle,
00216    size_t          Index
00217 );
00218 
00219 CHM_DLL_FUNC(CHMconfigRemoveSepChar)
00220 (
00221    CHMconfigHandle Handle,
00222    size_t          Index
00223 );
00224 
00225 CHM_DLL_FUNC(CHMconfigGetLowestNonEscapedChar)
00226 (
00227    CHMconfigHandle Handle,
00228    unsigned short*          pChar          
00229 );
00230 
00231 CHM_DLL_FUNC(CHMconfigSetLowestNonEscapedChar)
00232 (
00233    CHMconfigHandle Handle,
00234    unsigned short           Char          
00235 );
00236 
00237 CHM_DLL_FUNC(CHMconfigGetHighestNonEscapedChar)
00238 (
00239    CHMconfigHandle Handle,
00240    unsigned short*          pChar          
00241 );
00242 
00243 CHM_DLL_FUNC(CHMconfigSetHighestNonEscapedChar)
00244 (
00245    CHMconfigHandle Handle,
00246    unsigned short           Char          
00247 );
00248 
00249 CHM_DLL_FUNC(CHMconfigGetPresetConfig)
00250 (
00251    CHMconfigHandle Handle,
00252    const CHMchar**       ppName
00253 );
00254 
00255 CHM_DLL_FUNC(CHMconfigSetPresetConfig)
00256 (
00257    CHMconfigHandle Handle,
00258    const CHMchar*        pName
00259 );
00260 
00261 
00262 CHM_DLL_FUNC(CHMconfigSetPresetConfig)
00263 (
00264    CHMconfigHandle Handle,
00265    const CHMchar*        pName
00266 );
00267 
00268 CHM_DLL_FUNC(CHMconfigSetDatabaseLabel)
00269 (
00270    CHMconfigHandle Handle,
00271    size_t DatabaseLabel,
00272    const CHMchar* pLabel
00273 );
00274 
00275 CHM_DLL_FUNC(CHMconfigSetDatabaseAPI)
00276 (
00277    CHMconfigHandle Handle,
00278    size_t DatabaseIndex,
00279    const CHMchar* pAPI
00280 );
00281 
00282 CHM_DLL_FUNC(CHMconfigSetDatabaseName)
00283 (
00284    CHMconfigHandle Handle,
00285    size_t DatabaseIndex,
00286    const CHMchar* pName
00287 );
00288 
00289 CHM_DLL_FUNC(CHMconfigSetDatabaseUserName)
00290 (
00291    CHMconfigHandle Handle,
00292    size_t DatabaseIndex,
00293    const CHMchar* pName
00294 );
00295 
00296 CHM_DLL_FUNC(CHMconfigSetDatabasePassword)
00297 (
00298    CHMconfigHandle Handle,
00299    size_t DatabaseIndex,
00300    const CHMchar* pPassword
00301 );
00302 
00303 CHM_DLL_FUNC(CHMconfigGetDatabaseAPI)
00304 (
00305    CHMconfigHandle Handle,
00306    size_t          DatabaseIndex,
00307    const char**    ppDatabaseAPI
00308 );
00309 
00310 CHM_DLL_FUNC(CHMconfigGetDatabaseLabel)
00311 (
00312    CHMconfigHandle Handle,
00313    size_t          DatabaseIndex,
00314    const char**    ppDatabaseLabel
00315 );
00316 
00317 CHM_DLL_FUNC(CHMconfigGetDatabaseName)
00318 (
00319    CHMconfigHandle Handle,
00320    size_t          DatabaseIndex,
00321    const char**    ppDatabaseName
00322 );
00323 
00324 CHM_DLL_FUNC(CHMconfigGetDatabaseUserName)
00325 (
00326    CHMconfigHandle Handle,
00327    size_t          DatabaseIndex,
00328    const char**    ppDatabaseUserName
00329 );
00330 
00331 CHM_DLL_FUNC(CHMconfigGetDatabasePassword)
00332 (
00333    CHMconfigHandle Handle,
00334    size_t          DatabaseIndex,
00335    const char**    ppDatabasePassword
00336 );
00337 
00338 CHM_DLL_FUNC(CHMconfigGetDatabaseCount)
00339 (
00340    CHMconfigHandle Handle,
00341    size_t*         pCount
00342 );
00343 
00344 CHM_DLL_FUNC(CHMconfigGetDefaultDatabaseIndex)
00345 (
00346    CHMconfigHandle Handle,
00347    size_t*         pIndex
00348 );
00349 
00350 CHM_DLL_FUNC(CHMconfigSetDefaultDatabaseIndex)
00351 (
00352    CHMconfigHandle Handle,
00353    size_t          Index
00354 );
00355 
00356 CHM_DLL_FUNC(CHMconfigGetDatabaseIndex)
00357 (
00358    CHMconfigHandle Handle,
00359    const CHMchar*  pLabel,
00360    size_t*         pIndex
00361 );
00362 
00363 CHM_DLL_FUNC(CHMconfigAddDatabase)
00364 (
00365    CHMconfigHandle Handle,
00366    size_t*         pIndex
00367 );
00368 
00369 CHM_DLL_FUNC(CHMconfigRemoveDatabase)
00370 (
00371    CHMconfigHandle Handle,
00372    size_t         Index
00373 );
00374 
00375 CHM_DLL_FUNC(CHMconfigGetIsDatabaseFunctionOn)
00376 (
00377    CHMconfigHandle Handle,
00378    size_t*         pFlag
00379 );
00380 
00381 CHM_DLL_FUNC(CHMconfigSetIsDatabaseFunctionOn)
00382 (
00383    CHMconfigHandle Handle,
00384    size_t          Flag
00385 );
00386 
00387 CHM_DLL_FUNC(CHMconfigGetDisablePythonNone)
00388 (
00389    CHMconfigHandle Handle,
00390    size_t*         pFlag
00391 );
00392 
00393 CHM_DLL_FUNC(CHMconfigSetDisablePythonNone)
00394 (
00395    CHMconfigHandle Handle,
00396    size_t          Flag
00397 );
00398 
00399 CHM_DLL_FUNC(CHMconfigCountOfDatabaseApi)
00400 (
00401    CHMconfigHandle Handle,
00402    int* pCount
00403 );
00404 
00405 CHM_DLL_FUNC(CHMconfigGetDatabaseApiName)
00406 (
00407    CHMconfigHandle Handle,
00408    int Index,
00409    const CHMchar** ppDatabaseApiName
00410 );
00411 
00412 #endif // end of defensive include