Logo Search packages:      
Sourcecode: maxdb-7.5.00 version File versions

RTE_IniFileHandling.h File Reference


Detailed Description

Handling of '.ini' files on UNIX.

---------------------------------------------------------------------

Author:
JoergM
Each .ini File consists of sections, which are identified by a section header. The section header consists of an name framed by brackets. Each entry in the section consists of a key an value separated by an equal sign. The section is seperated from the next section by an empty line. Example SAPDB_Tech.ini

[Database] SUT72=/home/remuser/releases/V72/usr MUT7264=/home/remuser/releases/V7264/usr

Definition in file RTE_IniFileHandling.h.

#include "RunTime/RTE_Types.h"
#include "SAPDBCommon/SAPDB_C_Cplusplus.h"

Go to the source code of this file.

Classes

struct  RTE_RegistryHandleStruct_

Defines

#define SAPDB_INIFILE_RESULT_EOF   ((RTE_IniFileResult)8)
#define SAPDB_INIFILE_RESULT_ERR_CLOSE   ((RTE_IniFileResult)2)
#define SAPDB_INIFILE_RESULT_ERR_KEY   ((RTE_IniFileResult)7)
#define SAPDB_INIFILE_RESULT_ERR_LOCK   ((RTE_IniFileResult)10)
#define SAPDB_INIFILE_RESULT_ERR_MEMORY   ((RTE_IniFileResult)5)
#define SAPDB_INIFILE_RESULT_ERR_OPEN   ((RTE_IniFileResult)1)
#define SAPDB_INIFILE_RESULT_ERR_PARAM   ((RTE_IniFileResult)13)
#define SAPDB_INIFILE_RESULT_ERR_READ   ((RTE_IniFileResult)9)
#define SAPDB_INIFILE_RESULT_ERR_SEEK   ((RTE_IniFileResult)12)
#define SAPDB_INIFILE_RESULT_ERR_TEMP   ((RTE_IniFileResult)3)
#define SAPDB_INIFILE_RESULT_ERR_WRITE   ((RTE_IniFileResult)4)
#define SAPDB_INIFILE_RESULT_NO_ENTRY   ((RTE_IniFileResult)6)
#define SAPDB_INIFILE_RESULT_OK   ((RTE_IniFileResult)0)
#define SAPDB_INIFILE_RESULT_TRUNCATED   ((RTE_IniFileResult)11)

Typedefs

typedef SAPDB_Char RTE_IniFileErrtext [40]
typedef SAPDB_Byte RTE_IniFileResult
typedef struct
RTE_RegistryHandleStruct_
RTE_RegistryHandle
typedef struct
RTE_RegistryHandleStruct_ 
RTE_RegistryHandleStruct
typedef enum RTE_RegistryLocation_ RTE_RegistryLocation

Enumerations

enum  RTE_RegistryLocation_ { RTE_UserRegistry, RTE_GlobalRegistry, RTE_OldUNIXRegistry }

Functions

SAPDB_Int4 RTE_CloseConfigEnum (RTE_RegistryHandle hEnum, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Closes registry opened by SAPDB_OpenConfigFile ().
SAPDB_Bool RTE_GetCommonConfigPath (RTE_Path VAR_ARRAY_REF ConfigPath, SAPDB_Bool TerminateWithDelimiter, RTE_IniFileErrtext VAR_ARRAY_REF ErrText)
 Get User Independend - Common - Config Path.
SAPDB_Bool RTE_GetCommonDataPath (RTE_Path VAR_ARRAY_REF ConfigPath, SAPDB_Bool TerminateWithDelimiter, RTE_IniFileErrtext VAR_ARRAY_REF ErrText)
 Get Common Independend Data Path.
SAPDB_Int4 RTE_GetConfigString (const SAPDB_Char *szFile, const SAPDB_Char *szSection, const SAPDB_Char *szEntry, SAPDB_Char *szString, const SAPDB_Int4 StringSize, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Read Config Entry.
SAPDB_Int4 RTE_GetGlobalConfigString (const SAPDB_Char *szFile, const SAPDB_Char *szSection, const SAPDB_Char *szEntry, SAPDB_Char *szString, const SAPDB_Int4 StringSize, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Read Common Config Entry.
SAPDB_Int4 RTE_GetInstallationConfigString (const SAPDB_Char *szEntry, SAPDB_Char *szString, const SAPDB_Int4 StringSize, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Read Global Config Entry.
SAPDB_Int4 RTE_GetUserConfigString (const SAPDB_Char *szFile, const SAPDB_Char *szSection, const SAPDB_Char *szEntry, SAPDB_Char *szString, const SAPDB_Int4 StringSize, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Read User Specific Config Entry.
SAPDB_Bool RTE_GetUserSpecificConfigPath (RTE_Path VAR_ARRAY_REF ConfigPath, SAPDB_Bool TerminateWithDelimiter, RTE_IniFileErrtext VAR_ARRAY_REF ErrText)
 Get User Specific Config Path.
SAPDB_Int4 RTE_NextConfigEnum (RTE_RegistryHandle hEnum, SAPDB_Char *szEntry, const SAPDB_Int4 MaxEntryLen, SAPDB_Char *szString, const SAPDB_Int4 MaxStringLen, RTE_RegistryLocation VAR_VALUE_REF pLocation, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Reads next entry from registry opened by SAPDB_OpenConfigFile ().
RTE_RegistryHandle RTE_OpenConfigEnum (const SAPDB_Char *szFile, const SAPDB_Char *szSection, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Open registry for enumeration of a section.
RTE_RegistryHandle RTE_OpenGlobalConfigEnum (const SAPDB_Char *szFile, const SAPDB_Char *szSection, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Open registry for enumeration of a section.
RTE_RegistryHandle RTE_OpenUserConfigEnum (const SAPDB_Char *szFile, const SAPDB_Char *szSection, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Open User specific registry for enumeration of a section.
SAPDB_Int4 RTE_PutConfigString (const SAPDB_Char *szFile, const SAPDB_Char *szSection, const SAPDB_Char *szEntry, const SAPDB_Char *szString, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Write or update Registry Entry.
SAPDB_Int4 RTE_PutInstallationConfigString (const SAPDB_Char *szEntry, const SAPDB_Char *szString, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Write or update global registry Entry.
SAPDB_Int4 RTE_PutUserConfigString (const SAPDB_Char *szFile, const SAPDB_Char *szSection, const SAPDB_Char *szEntry, const SAPDB_Char *szString, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Write or update user specific registry Entry.
SAPDB_Int4 RTE_RemoveConfigString (const SAPDB_Char *szFile, const SAPDB_Char *szSection, const SAPDB_Char *szEntry, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Remove entry from Registry Removes the entry specified by 'szSection' and 'szEntry' from config file This function needs write permission in 'indepData/config' to create a temporary file, otherwise it fails .
SAPDB_Int4 RTE_RemoveUserConfigString (const SAPDB_Char *szFile, const SAPDB_Char *szSection, const SAPDB_Char *szEntry, RTE_IniFileErrtext VAR_ARRAY_REF ErrText, RTE_IniFileResult VAR_VALUE_REF Ok)
 Remove User specific Entry from Registry.


Generated by  Doxygen 1.6.0   Back to index