Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


Methods of Class Profile


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

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Open or create a configuration profile.
Return
0 if the profile could not be created, otherwise a handle to the profile.

~Profile
~Profile();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Close the opened profile an flush all data to the disk.
Parameters
Profile
handle to a opened profile.

flush
sal_Bool flush();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO


readString
rtl::OString readString(
const rtl::OString & rSection,
const rtl::OString & rEntry,
const rtl::OString & rDefault );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO


readBool
sal_Bool readBool(
const rtl::OString & rSection,
const rtl::OString & rEntry,
sal_Bool bDefault );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO


readIdent
sal_uInt32 readIdent(
const rtl::OString & rSection,
const rtl::OString & rEntry,
sal_uInt32 nFirstId,
const std::list< rtl::OString > & rStrings,
sal_uInt32 nDefault );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO


writeString
sal_Bool writeString(
const rtl::OString & rSection,
const rtl::OString & rEntry,
const rtl::OString & rString );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO


writeBool
sal_Bool writeBool(
const rtl::OString & rSection,
const rtl::OString & rEntry,
sal_Bool Value );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO


writeIdent
sal_Bool writeIdent(
const rtl::OString & rSection,
const rtl::OString & rEntry,
sal_uInt32 nFirstId,
const std::list< rtl::OString > & rStrings,
sal_uInt32 nValue );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO


removeEntry
sal_Bool removeEntry(
const rtl::OString & rSection,
const rtl::OString & rEntry );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Acquire the mutex, block if already acquired by another thread.
Parameters
Profile
handle to a opened profile.
Return
False if section or entry could not be found.

getSectionEntries
std::list< rtl::OString > getSectionEntries(
const rtl::OString & rSection );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Get all entries belonging to the specified section.
Parameters
Profile
handle to a opened profile.
Return
Pointer to a array of pointers.

getSections
std::list< rtl::OString > getSections();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Get all section entries
Parameters
Profile
handle to a opened profile.
Return
Pointer to a array of pointers.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.