/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_OSL_PROFILE_H
#define INCLUDED_OSL_PROFILE_H
#include "sal/config.h"
#include "rtl/ustring.h"
#include "sal/saldllapi.h"
#include "sal/types.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef sal_uInt32 oslProfileOption;
#define osl_Profile_DEFAULT 0x0000
#define osl_Profile_SYSTEM 0x0001 /* use system depended functinality */
#define osl_Profile_READLOCK 0x0002 /* lock file for reading */
#define osl_Profile_WRITELOCK 0x0004 /* lock file for writing */
#define osl_Profile_FLUSHWRITE 0x0010 /* writing only with flush */
typedef void* oslProfile;
/** Deprecated API.
Open or create a configuration profile.
@retval 0 if the profile could not be created, otherwise a handle to the profile.
@deprecated
*/
SAL_DLLPUBLIC oslProfile SAL_CALL osl_openProfile(
rtl_uString *strProfileName, oslProfileOption Options) SAL_COLD;
/** Deprecated API.
Close the opened profile an flush all data to the disk.
@param Profile handle to a opened profile.
@deprecated
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_closeProfile(
oslProfile Profile) SAL_COLD;
/** Deprecated API.
@deprecated
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_flushProfile(
oslProfile Profile) SAL_COLD;
/** Deprecated API.
@deprecated
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_readProfileString(
oslProfile Profile,
const sal_Char* pszSection, const sal_Char* pszEntry,
sal_Char* pszString, sal_uInt32 MaxLen,
const sal_Char* pszDefault) SAL_COLD;
/** Deprecated API.
@deprecated
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_readProfileBool(
oslProfile Profile,
const sal_Char* pszSection, const sal_Char* pszEntry,
sal_Bool Default) SAL_COLD;
/** Deprecated API.
@deprecated
*/
SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_readProfileIdent(
oslProfile Profile,
const sal_Char* pszSection, const sal_Char* pszEntry,
sal_uInt32 FirstId, const sal_Char* Strings[],
sal_uInt32 Default) SAL_COLD;
/** Deprecated API.
@deprecated
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileString(
oslProfile Profile,
const sal_Char* pszSection, const sal_Char* pszEntry,
const sal_Char* pszString) SAL_COLD;
/** Deprecated API.
@deprecated
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileBool(
oslProfile Profile,
const sal_Char* pszSection, const sal_Char* pszEntry,
sal_Bool Value) SAL_COLD;
/** Deprecated API.
@deprecated
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_writeProfileIdent(
oslProfile Profile,
const sal_Char* pszSection, const sal_Char* pszEntry,
sal_uInt32 FirstId, const sal_Char* Strings[],
sal_uInt32 Value) SAL_COLD;
/** Deprecated API.
Acquire the mutex, block if already acquired by another thread.
@retval False if section or entry could not be found.
@deprecated
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_removeProfileEntry(
oslProfile Profile,
const sal_Char *pszSection, const sal_Char *pszEntry) SAL_COLD;
/** Deprecated API.
Get all entries belonging to the specified section.
@returns Pointer to a array of pointers.
@deprecated
*/
SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSectionEntries(
oslProfile Profile, const sal_Char *pszSection,
sal_Char* pszBuffer, sal_uInt32 MaxLen) SAL_COLD;
/** Deprecated API.
Get all section entries
@retval Pointer to a array of pointers.
@deprecated
*/
SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getProfileSections(
oslProfile Profile, sal_Char* pszBuffer, sal_uInt32 MaxLen) SAL_COLD;
#ifdef __cplusplus
}
#endif
#endif // INCLUDED_OSL_PROFILE_H
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
4-2-5