include/osl/profile.h

   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
  44 /** Deprecated API.
  45     Open or create a configuration profile.
  46     @retval 0 if the profile could not be created, otherwise a handle to the profile.
  47     @deprecated
  48 */
  49 SAL_DLLPUBLIC oslProfile SAL_CALL osl_openProfile(
  50         rtl_uString *strProfileName, oslProfileOption Options) SAL_COLD;
  51
  52 /** Deprecated API.
  53     Close the opened profile an flush all data to the disk.
  54     @param Profile handle to an opened profile.
  55     @deprecated
  56 */
  57 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_closeProfile(
  58         oslProfile Profile) SAL_COLD;
  59
  60 /** Deprecated API.
  61     @deprecated
  62 */
  63
  64 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_flushProfile(
  65         oslProfile Profile) SAL_COLD;
  66 /** Deprecated API.
  67     @deprecated
  68 */
  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) SAL_COLD;
  74 /** Deprecated API.
  75     @deprecated
  76 */
  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) SAL_COLD;
  81 /** Deprecated API.
  82     @deprecated
  83 */
  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) SAL_COLD;
  89
  90 /** Deprecated API.
  91     @deprecated
  92 */
  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) SAL_COLD;
  97
  98 /** Deprecated API.
  99     @deprecated
 100 */
 101 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileBool(
 102                              oslProfile Profile,
 103                              const sal_Char* pszSection, const sal_Char* pszEntry,
 104                              sal_Bool Value) SAL_COLD;
 105
 106 /** Deprecated API.
 107     @deprecated
 108 */
 109 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileIdent(
 110                               oslProfile Profile,
 111                               const sal_Char* pszSection, const sal_Char* pszEntry,
 112                               sal_uInt32 FirstId, const sal_Char* Strings[],
 113                               sal_uInt32 Value) SAL_COLD;
 114
 115 /** Deprecated API.
 116     Acquire the mutex, block if already acquired by another thread.
 117     @retval False if section or entry could not be found.
 118     @deprecated
 119 */
 120 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_removeProfileEntry(
 121                            oslProfile Profile,
 122                            const sal_Char *pszSection, const sal_Char *pszEntry) SAL_COLD;
 123
 124 /** Deprecated API.
 125     Get all entries belonging to the specified section.
 126     @returns Pointer to an array of pointers.
 127     @deprecated
 128 */
 129 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSectionEntries(
 130                             oslProfile Profile, const sal_Char *pszSection,
 131                             sal_Char* pszBuffer, sal_uInt32 MaxLen) SAL_COLD;
 132
 133 /** Deprecated API.
 134     Get all section entries
 135     @retval Pointer to an array of pointers.
 136     @deprecated
 137 */
 138 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSections(
 139         oslProfile Profile, sal_Char* pszBuffer, sal_uInt32 MaxLen) SAL_COLD;
 140
 141 #ifdef __cplusplus
 142 }
 143 #endif
 144
 145 #endif // INCLUDED_OSL_PROFILE_H
 146
 147 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */