LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
osl::Profile Class Reference

Deprecated API. More...

#include <profile.hxx>

Public Member Functions

 Profile (const rtl::OUString &strProfileName, oslProfileOption Options=Profile_DEFAULT)
 Open or create a configuration profile. More...
 
 ~Profile ()
 Close the opened profile an flush all data to the disk. More...
 
bool flush ()
 
rtl::OString readString (const rtl::OString &rSection, const rtl::OString &rEntry, const rtl::OString &rDefault)
 
bool readBool (const rtl::OString &rSection, const rtl::OString &rEntry, bool bDefault)
 
sal_uInt32 readIdent (const rtl::OString &rSection, const rtl::OString &rEntry, sal_uInt32 nFirstId, const std::list< rtl::OString > &rStrings, sal_uInt32 nDefault)
 
bool writeString (const rtl::OString &rSection, const rtl::OString &rEntry, const rtl::OString &rString)
 
bool writeBool (const rtl::OString &rSection, const rtl::OString &rEntry, bool Value)
 
bool writeIdent (const rtl::OString &rSection, const rtl::OString &rEntry, sal_uInt32 nFirstId, const std::list< rtl::OString > &rStrings, sal_uInt32 nValue)
 
bool removeEntry (const rtl::OString &rSection, const rtl::OString &rEntry)
 Remove an entry from a section. More...
 
std::list< rtl::OStringgetSectionEntries (const rtl::OString &rSection)
 Get all entries belonging to the specified section. More...
 
std::list< rtl::OStringgetSections ()
 Get all section entries. More...
 

Detailed Description

Deprecated API.

Deprecated:

Constructor & Destructor Documentation

osl::Profile::Profile ( const rtl::OUString strProfileName,
oslProfileOption  Options = Profile_DEFAULT 
)
inline

Open or create a configuration profile.

Returns
0 if the profile could not be created, otherwise a handle to the profile.
osl::Profile::~Profile ( )
inline

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

Member Function Documentation

bool osl::Profile::flush ( )
inline
std::list< rtl::OString > osl::Profile::getSectionEntries ( const rtl::OString rSection)
inline

Get all entries belonging to the specified section.

Parameters
rSectionName of the section.
Returns
Pointer to a array of pointers.
std::list< rtl::OString > osl::Profile::getSections ( )
inline

Get all section entries.

Returns
Pointer to a array of pointers.
bool osl::Profile::readBool ( const rtl::OString rSection,
const rtl::OString rEntry,
bool  bDefault 
)
inline
sal_uInt32 osl::Profile::readIdent ( const rtl::OString rSection,
const rtl::OString rEntry,
sal_uInt32  nFirstId,
const std::list< rtl::OString > &  rStrings,
sal_uInt32  nDefault 
)
inline
rtl::OString osl::Profile::readString ( const rtl::OString rSection,
const rtl::OString rEntry,
const rtl::OString rDefault 
)
inline
bool osl::Profile::removeEntry ( const rtl::OString rSection,
const rtl::OString rEntry 
)
inline

Remove an entry from a section.

Parameters
rSectionName of the section.
rEntryName of the entry to remove.
Returns
False if section or entry could not be found.
bool osl::Profile::writeBool ( const rtl::OString rSection,
const rtl::OString rEntry,
bool  Value 
)
inline
bool osl::Profile::writeIdent ( const rtl::OString rSection,
const rtl::OString rEntry,
sal_uInt32  nFirstId,
const std::list< rtl::OString > &  rStrings,
sal_uInt32  nValue 
)
inline
bool osl::Profile::writeString ( const rtl::OString rSection,
const rtl::OString rEntry,
const rtl::OString rString 
)
inline

The documentation for this class was generated from the following file: