LibreOffice: osl/profile.h Source File

LibreOffice LibreOffice 4.4 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

profile.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef INCLUDED_OSL_PROFILE_H
21 #define INCLUDED_OSL_PROFILE_H
22
23 #include <sal/config.h>
24
25 #include <rtl/ustring.h>
26 #include <sal/saldllapi.h>
27 #include <sal/types.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 typedef sal_uInt32 oslProfileOption;
34
35 #define osl_Profile_DEFAULT 0x0000
36 #define osl_Profile_SYSTEM 0x0001 /* use system depended functinality */
37 #define osl_Profile_READLOCK 0x0002 /* lock file for reading */
38 #define osl_Profile_WRITELOCK 0x0004 /* lock file for writing */
39 #define osl_Profile_FLUSHWRITE 0x0010 /* writing only with flush */
40
41
42 typedef void* oslProfile;
43
49 SAL_DLLPUBLIC oslProfile SAL_CALL osl_openProfile(
50 rtl_uString *strProfileName, oslProfileOption Options);
51
57 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_closeProfile(
58 oslProfile Profile);
59
60
64 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_flushProfile(
65 oslProfile Profile);
69 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_readProfileString(
70 oslProfile Profile,
71 const sal_Char* pszSection, const sal_Char* pszEntry,
72 sal_Char* pszString, sal_uInt32 MaxLen,
73 const sal_Char* pszDefault);
77 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_readProfileBool(
78 oslProfile Profile,
79 const sal_Char* pszSection, const sal_Char* pszEntry,
80 sal_Bool Default);
84 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_readProfileIdent(
85 oslProfile Profile,
86 const sal_Char* pszSection, const sal_Char* pszEntry,
87 sal_uInt32 FirstId, const sal_Char* Strings[],
88 sal_uInt32 Default);
89
93 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileString(
94 oslProfile Profile,
95 const sal_Char* pszSection, const sal_Char* pszEntry,
96 const sal_Char* pszString);
100 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileBool(
101 oslProfile Profile,
102 const sal_Char* pszSection, const sal_Char* pszEntry,
103 sal_Bool Value);
107 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileIdent(
108 oslProfile Profile,
109 const sal_Char* pszSection, const sal_Char* pszEntry,
110 sal_uInt32 FirstId, const sal_Char* Strings[],
111 sal_uInt32 Value);
112
118 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_removeProfileEntry(
119 oslProfile Profile,
120 const sal_Char *pszSection, const sal_Char *pszEntry);
121
127 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSectionEntries(
128 oslProfile Profile, const sal_Char *pszSection,
129 sal_Char* pszBuffer, sal_uInt32 MaxLen);
130
136 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSections(
137 oslProfile Profile, sal_Char* pszBuffer, sal_uInt32 MaxLen);
138
139 #ifdef __cplusplus
140 }
141 #endif
142
143 #endif // INCLUDED_OSL_PROFILE_H
144
145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
oslProfileOption
sal_uInt32 oslProfileOption
Definition: profile.h:33
sal_Bool
unsigned char sal_Bool
Definition: types.h:48
saldllapi.h
osl_openProfile
SAL_DLLPUBLIC oslProfile osl_openProfile(rtl_uString *strProfileName, oslProfileOption Options)
Deprecated API.
osl_readProfileIdent
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.
ustring.h
sal_Char
char sal_Char
A legacy synonym for char.
Definition: types.h:130
osl_getProfileSectionEntries
SAL_DLLPUBLIC sal_uInt32 osl_getProfileSectionEntries(oslProfile Profile, const sal_Char *pszSection, sal_Char *pszBuffer, sal_uInt32 MaxLen)
Deprecated API.
osl_writeProfileBool
SAL_DLLPUBLIC sal_Bool osl_writeProfileBool(oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, sal_Bool Value)
Deprecated API.
oslProfile
void * oslProfile
Definition: profile.h:42
osl_readProfileBool
SAL_DLLPUBLIC sal_Bool osl_readProfileBool(oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, sal_Bool Default)
Deprecated API.
osl_writeProfileIdent
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.
types.h
osl_flushProfile
SAL_DLLPUBLIC sal_Bool osl_flushProfile(oslProfile Profile)
Deprecated API.
osl_getProfileSections
SAL_DLLPUBLIC sal_uInt32 osl_getProfileSections(oslProfile Profile, sal_Char *pszBuffer, sal_uInt32 MaxLen)
Deprecated API.
osl_closeProfile
SAL_DLLPUBLIC sal_Bool osl_closeProfile(oslProfile Profile)
Deprecated API.
osl_readProfileString
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.
config.h
osl_removeProfileEntry
SAL_DLLPUBLIC sal_Bool osl_removeProfileEntry(oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry)
Deprecated API.
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
osl_writeProfileString
SAL_DLLPUBLIC sal_Bool osl_writeProfileString(oslProfile Profile, const sal_Char *pszSection, const sal_Char *pszEntry, const sal_Char *pszString)
Deprecated API.