UDK 3.2.7 C/C++ API Reference

osl/profile.h

Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /*
00003  * This file is part of the LibreOffice project.
00004  *
00005  * This Source Code Form is subject to the terms of the Mozilla Public
00006  * License, v. 2.0. If a copy of the MPL was not distributed with this
00007  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
00008  *
00009  * This file incorporates work covered by the following license notice:
00010  *
00011  *   Licensed to the Apache Software Foundation (ASF) under one or more
00012  *   contributor license agreements. See the NOTICE file distributed
00013  *   with this work for additional information regarding copyright
00014  *   ownership. The ASF licenses this file to you under the Apache
00015  *   License, Version 2.0 (the "License"); you may not use this file
00016  *   except in compliance with the License. You may obtain a copy of
00017  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
00018  */
00019 
00020 #ifndef _OSL_PROFILE_H_
00021 #define _OSL_PROFILE_H_
00022 
00023 #include "sal/config.h"
00024 
00025 #include "rtl/ustring.h"
00026 #include "sal/saldllapi.h"
00027 #include "sal/types.h"
00028 
00029 #ifdef __cplusplus
00030 extern "C" {
00031 #endif
00032 
00033 typedef sal_uInt32 oslProfileOption;
00034 
00035 #define osl_Profile_DEFAULT     0x0000
00036 #define osl_Profile_SYSTEM      0x0001    /* use system depended functinality */
00037 #define osl_Profile_READLOCK    0x0002    /* lock file for reading            */
00038 #define osl_Profile_WRITELOCK   0x0004    /* lock file for writing            */
00039 #define osl_Profile_FLUSHWRITE  0x0010    /* writing only with flush          */
00040 
00041 
00042 typedef void* oslProfile;
00043 
00049 SAL_DLLPUBLIC oslProfile SAL_CALL osl_openProfile(
00050         rtl_uString *strProfileName, oslProfileOption Options);
00051 
00057 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_closeProfile(
00058         oslProfile Profile);
00059 
00060 
00064 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_flushProfile(
00065         oslProfile Profile);
00069 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_readProfileString(
00070                               oslProfile Profile,
00071                               const sal_Char* pszSection, const sal_Char* pszEntry,
00072                               sal_Char* pszString, sal_uInt32 MaxLen,
00073                               const sal_Char* pszDefault);
00077 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_readProfileBool(
00078                             oslProfile Profile,
00079                             const sal_Char* pszSection, const sal_Char* pszEntry,
00080                             sal_Bool Default);
00084 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_readProfileIdent(
00085                               oslProfile Profile,
00086                               const sal_Char* pszSection, const sal_Char* pszEntry,
00087                               sal_uInt32 FirstId, const sal_Char* Strings[],
00088                               sal_uInt32 Default);
00089 
00093 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileString(
00094                                oslProfile Profile,
00095                                const sal_Char* pszSection, const sal_Char* pszEntry,
00096                                const sal_Char* pszString);
00100 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileBool(
00101                              oslProfile Profile,
00102                              const sal_Char* pszSection, const sal_Char* pszEntry,
00103                              sal_Bool Value);
00107 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileIdent(
00108                               oslProfile Profile,
00109                               const sal_Char* pszSection, const sal_Char* pszEntry,
00110                               sal_uInt32 FirstId, const sal_Char* Strings[],
00111                               sal_uInt32 Value);
00112 
00118 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_removeProfileEntry(
00119                            oslProfile Profile,
00120                            const sal_Char *pszSection, const sal_Char *pszEntry);
00121 
00127 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSectionEntries(
00128                             oslProfile Profile, const sal_Char *pszSection,
00129                             sal_Char* pszBuffer, sal_uInt32 MaxLen);
00130 
00136 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSections(
00137         oslProfile Profile, sal_Char* pszBuffer, sal_uInt32 MaxLen);
00138 
00139 #ifdef __cplusplus
00140 }
00141 #endif
00142 
00143 #endif  /* _OSL_PROFILE_H_ */
00144 
00145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines