osl/profile.h File Reference

#include "sal/config.h"
#include "rtl/ustring.h"
#include "sal/saldllapi.h"
#include "sal/types.h"

Go to the source code of this file.

Defines
#define	osl_Profile_DEFAULT   0x0000
#define	osl_Profile_SYSTEM   0x0001
#define	osl_Profile_READLOCK   0x0002
#define	osl_Profile_WRITELOCK   0x0004
#define	osl_Profile_FLUSHWRITE   0x0010
Typedefs
typedef sal_uInt32	oslProfileOption
typedef void *	oslProfile
Functions
SAL_DLLPUBLIC oslProfile	osl_openProfile (rtl_uString *strProfileName, oslProfileOption Options)
	Deprecated API.
SAL_DLLPUBLIC sal_Bool	osl_closeProfile (oslProfile Profile)
	Deprecated API.
SAL_DLLPUBLIC sal_Bool	osl_flushProfile (oslProfile Profile)
	Deprecated API.
SAL_DLLPUBLIC sal_Bool	osl_readProfileString (oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, sal_Char *pszString, sal_uInt32 MaxLen, const sal_Char *pszDefault)
	Deprecated API.
SAL_DLLPUBLIC sal_Bool	osl_readProfileBool (oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, sal_Bool Default)
	Deprecated API.
SAL_DLLPUBLIC sal_uInt32	osl_readProfileIdent (oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, sal_uInt32 FirstId, const sal_Char *Strings[], sal_uInt32 Default)
	Deprecated API.
SAL_DLLPUBLIC sal_Bool	osl_writeProfileString (oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, const sal_Char *pszString)
	Deprecated API.
SAL_DLLPUBLIC sal_Bool	osl_writeProfileBool (oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, sal_Bool Value)
	Deprecated API.
SAL_DLLPUBLIC sal_Bool	osl_writeProfileIdent (oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, sal_uInt32 FirstId, const sal_Char *Strings[], sal_uInt32 Value)
	Deprecated API.
SAL_DLLPUBLIC sal_Bool	osl_removeProfileEntry (oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry)
	Deprecated API.
SAL_DLLPUBLIC sal_uInt32	osl_getProfileSectionEntries (oslProfile Profile, const sal_Char *pszSection, sal_Char *pszBuffer, sal_uInt32 MaxLen)
	Deprecated API.
SAL_DLLPUBLIC sal_uInt32	osl_getProfileSections (oslProfile Profile, sal_Char *pszBuffer, sal_uInt32 MaxLen)
	Deprecated API.

---

Define Documentation

#define osl_Profile_DEFAULT   0x0000

#define osl_Profile_FLUSHWRITE   0x0010

#define osl_Profile_READLOCK   0x0002

#define osl_Profile_SYSTEM   0x0001

#define osl_Profile_WRITELOCK   0x0004

---

Typedef Documentation

typedef void* oslProfile

typedef sal_uInt32 oslProfileOption

---

Function Documentation

SAL_DLLPUBLIC sal_Bool osl_closeProfile

(

oslProfile

Profile

)

Deprecated API.

Close the opened profile an flush all data to the disk.

Parameters:

Profile

handle to a opened profile.

Deprecated:

SAL_DLLPUBLIC sal_Bool osl_flushProfile

(

oslProfile

Profile

)

Deprecated API.

Deprecated:

SAL_DLLPUBLIC sal_uInt32 osl_getProfileSectionEntries	(	oslProfile	Profile,
		const sal_Char *	pszSection,
		sal_Char *	pszBuffer,
		sal_uInt32	MaxLen
	)

Deprecated API.

Get all entries belonging to the specified section.

Returns:

Pointer to a array of pointers.

Deprecated:

SAL_DLLPUBLIC sal_uInt32 osl_getProfileSections	(	oslProfile	Profile,
		sal_Char *	pszBuffer,
		sal_uInt32	MaxLen
	)

Deprecated API.

Get all section entries

Returns:

Pointer to a array of pointers.

Deprecated:

SAL_DLLPUBLIC oslProfile osl_openProfile	(	rtl_uString *	strProfileName,
		oslProfileOption	Options
	)

Deprecated API.

Open or create a configuration profile.

Returns:

0 if the profile could not be created, otherwise a handle to the profile.

Deprecated:

SAL_DLLPUBLIC sal_Bool osl_readProfileBool	(	oslProfile	Profile,
		const sal_Char *	pszSection,
		const sal_Char *	pszEntry,
		sal_Bool	Default
	)

Deprecated API.

Deprecated:

SAL_DLLPUBLIC sal_uInt32 osl_readProfileIdent	(	oslProfile	Profile,
		const sal_Char *	pszSection,
		const sal_Char *	pszEntry,
		sal_uInt32	FirstId,
		const sal_Char *	Strings[],
		sal_uInt32	Default
	)

Deprecated API.

Deprecated:

SAL_DLLPUBLIC sal_Bool osl_readProfileString	(	oslProfile	Profile,
		const sal_Char *	pszSection,
		const sal_Char *	pszEntry,
		sal_Char *	pszString,
		sal_uInt32	MaxLen,
		const sal_Char *	pszDefault
	)

Deprecated API.

Deprecated:

SAL_DLLPUBLIC sal_Bool osl_removeProfileEntry	(	oslProfile	Profile,
		const sal_Char *	pszSection,
		const sal_Char *	pszEntry
	)

Deprecated API.

Acquire the mutex, block if already acquired by another thread.

Returns:

False if section or entry could not be found.

Deprecated:

SAL_DLLPUBLIC sal_Bool osl_writeProfileBool	(	oslProfile	Profile,
		const sal_Char *	pszSection,
		const sal_Char *	pszEntry,
		sal_Bool	Value
	)

Deprecated API.

Deprecated:

SAL_DLLPUBLIC sal_Bool osl_writeProfileIdent	(	oslProfile	Profile,
		const sal_Char *	pszSection,
		const sal_Char *	pszEntry,
		sal_uInt32	FirstId,
		const sal_Char *	Strings[],
		sal_uInt32	Value
	)

Deprecated API.

Deprecated:

SAL_DLLPUBLIC sal_Bool osl_writeProfileString	(	oslProfile	Profile,
		const sal_Char *	pszSection,
		const sal_Char *	pszEntry,
		const sal_Char *	pszString
	)

Deprecated API.

Deprecated: