1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef _OSL_PROFILE_H_ 29*cdf0e10cSrcweir #define _OSL_PROFILE_H_ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include <sal/types.h> 32*cdf0e10cSrcweir #include <rtl/ustring.h> 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir #ifdef __cplusplus 35*cdf0e10cSrcweir extern "C" { 36*cdf0e10cSrcweir #endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir typedef sal_uInt32 oslProfileOption; 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir #define osl_Profile_DEFAULT 0x0000 41*cdf0e10cSrcweir #define osl_Profile_SYSTEM 0x0001 /* use system depended functinality */ 42*cdf0e10cSrcweir #define osl_Profile_READLOCK 0x0002 /* lock file for reading */ 43*cdf0e10cSrcweir #define osl_Profile_WRITELOCK 0x0004 /* lock file for writing */ 44*cdf0e10cSrcweir #define osl_Profile_FLUSHWRITE 0x0010 /* writing only with flush */ 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir typedef void* oslProfile; 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir /** Deprecated API. 50*cdf0e10cSrcweir Open or create a configuration profile. 51*cdf0e10cSrcweir @return 0 if the profile could not be created, otherwise a handle to the profile. 52*cdf0e10cSrcweir @deprecated 53*cdf0e10cSrcweir */ 54*cdf0e10cSrcweir oslProfile SAL_CALL osl_openProfile(rtl_uString *strProfileName, oslProfileOption Options); 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir /** Deprecated API. 57*cdf0e10cSrcweir Close the opened profile an flush all data to the disk. 58*cdf0e10cSrcweir @param Profile handle to a opened profile. 59*cdf0e10cSrcweir @deprecated 60*cdf0e10cSrcweir */ 61*cdf0e10cSrcweir sal_Bool SAL_CALL osl_closeProfile(oslProfile Profile); 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir /** Deprecated API. 65*cdf0e10cSrcweir @deprecated 66*cdf0e10cSrcweir */ 67*cdf0e10cSrcweir sal_Bool SAL_CALL osl_flushProfile(oslProfile Profile); 68*cdf0e10cSrcweir /** Deprecated API. 69*cdf0e10cSrcweir @deprecated 70*cdf0e10cSrcweir */ 71*cdf0e10cSrcweir sal_Bool SAL_CALL osl_readProfileString(oslProfile Profile, 72*cdf0e10cSrcweir const sal_Char* pszSection, const sal_Char* pszEntry, 73*cdf0e10cSrcweir sal_Char* pszString, sal_uInt32 MaxLen, 74*cdf0e10cSrcweir const sal_Char* pszDefault); 75*cdf0e10cSrcweir /** Deprecated API. 76*cdf0e10cSrcweir @deprecated 77*cdf0e10cSrcweir */ 78*cdf0e10cSrcweir sal_Bool SAL_CALL osl_readProfileBool(oslProfile Profile, 79*cdf0e10cSrcweir const sal_Char* pszSection, const sal_Char* pszEntry, 80*cdf0e10cSrcweir sal_Bool Default); 81*cdf0e10cSrcweir /** Deprecated API. 82*cdf0e10cSrcweir @deprecated 83*cdf0e10cSrcweir */ 84*cdf0e10cSrcweir sal_uInt32 SAL_CALL osl_readProfileIdent(oslProfile Profile, 85*cdf0e10cSrcweir const sal_Char* pszSection, const sal_Char* pszEntry, 86*cdf0e10cSrcweir sal_uInt32 FirstId, const sal_Char* Strings[], 87*cdf0e10cSrcweir sal_uInt32 Default); 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir /** Deprecated API. 90*cdf0e10cSrcweir @deprecated 91*cdf0e10cSrcweir */ 92*cdf0e10cSrcweir sal_Bool SAL_CALL osl_writeProfileString(oslProfile Profile, 93*cdf0e10cSrcweir const sal_Char* pszSection, const sal_Char* pszEntry, 94*cdf0e10cSrcweir const sal_Char* pszString); 95*cdf0e10cSrcweir /** Deprecated API. 96*cdf0e10cSrcweir @deprecated 97*cdf0e10cSrcweir */ 98*cdf0e10cSrcweir sal_Bool SAL_CALL osl_writeProfileBool(oslProfile Profile, 99*cdf0e10cSrcweir const sal_Char* pszSection, const sal_Char* pszEntry, 100*cdf0e10cSrcweir sal_Bool Value); 101*cdf0e10cSrcweir /** Deprecated API. 102*cdf0e10cSrcweir @deprecated 103*cdf0e10cSrcweir */ 104*cdf0e10cSrcweir sal_Bool SAL_CALL osl_writeProfileIdent(oslProfile Profile, 105*cdf0e10cSrcweir const sal_Char* pszSection, const sal_Char* pszEntry, 106*cdf0e10cSrcweir sal_uInt32 FirstId, const sal_Char* Strings[], 107*cdf0e10cSrcweir sal_uInt32 Value); 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir /** Deprecated API. 110*cdf0e10cSrcweir Acquire the mutex, block if already acquired by another thread. 111*cdf0e10cSrcweir @param Profile handle to a opened profile. 112*cdf0e10cSrcweir @return False if section or entry could not be found. 113*cdf0e10cSrcweir @deprecated 114*cdf0e10cSrcweir */ 115*cdf0e10cSrcweir sal_Bool SAL_CALL osl_removeProfileEntry(oslProfile Profile, 116*cdf0e10cSrcweir const sal_Char *pszSection, const sal_Char *pszEntry); 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir /** Deprecated API. 119*cdf0e10cSrcweir Get all entries belonging to the specified section. 120*cdf0e10cSrcweir @param Profile handle to a opened profile. 121*cdf0e10cSrcweir @return Pointer to a array of pointers. 122*cdf0e10cSrcweir @deprecated 123*cdf0e10cSrcweir */ 124*cdf0e10cSrcweir sal_uInt32 SAL_CALL osl_getProfileSectionEntries(oslProfile Profile, const sal_Char *pszSection, 125*cdf0e10cSrcweir sal_Char* pszBuffer, sal_uInt32 MaxLen); 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir /** Deprecated API. 128*cdf0e10cSrcweir Get all section entries 129*cdf0e10cSrcweir @param Profile handle to a opened profile. 130*cdf0e10cSrcweir @return Pointer to a array of pointers. 131*cdf0e10cSrcweir @deprecated 132*cdf0e10cSrcweir */ 133*cdf0e10cSrcweir sal_uInt32 SAL_CALL osl_getProfileSections(oslProfile Profile, sal_Char* pszBuffer, sal_uInt32 MaxLen); 134*cdf0e10cSrcweir 135*cdf0e10cSrcweir #ifdef __cplusplus 136*cdf0e10cSrcweir } 137*cdf0e10cSrcweir #endif 138*cdf0e10cSrcweir 139*cdf0e10cSrcweir #endif /* _OSL_PROFILE_H_ */ 140*cdf0e10cSrcweir 141