LibreOffice: rtl/bootstrap.h Source File

LibreOffice LibreOffice 7.1 SDK C/C++ API Reference

bootstrap.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#ifndef INCLUDED_RTL_BOOTSTRAP_H
20#define INCLUDED_RTL_BOOTSTRAP_H
21
22#include "sal/config.h"
23
24#include "rtl/ustring.h"
25#include "sal/saldllapi.h"
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
116 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_setIniFileName( rtl_uString *pFileUri );
117
135 SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_bootstrap_get(
136 rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault );
137
145 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_set(
146 rtl_uString * pName, rtl_uString * pValue );
147
148
149 typedef void * rtlBootstrapHandle;
150
157 SAL_DLLPUBLIC rtlBootstrapHandle SAL_CALL rtl_bootstrap_args_open(rtl_uString * pIniName);
158
163 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_args_close(rtlBootstrapHandle handle)
164 SAL_THROW_EXTERN_C();
165
174 SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_bootstrap_get_from_handle(
175 rtlBootstrapHandle handle, rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault);
176
177
183 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_get_iniName_from_handle(
184 rtlBootstrapHandle handle, rtl_uString ** ppIniName);
185
191 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_expandMacros_from_handle(
192 rtlBootstrapHandle handle, rtl_uString ** macro );
193
198 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_expandMacros(
199 rtl_uString ** macro);
200
211 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_encode(
212 rtl_uString const * value, rtl_uString ** encoded );
213
214#ifdef __cplusplus
215}
216#endif
217
218#endif
219
220/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
config.h
sal_Bool
unsigned char sal_Bool
Definition: types.h:34
SAL_THROW_EXTERN_C
#define SAL_THROW_EXTERN_C()
Nothrow specification for C functions.
Definition: types.h:324
saldllapi.h
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
ustring.h
rtl_bootstrap_encode
SAL_DLLPUBLIC void rtl_bootstrap_encode(rtl_uString const *value, rtl_uString **encoded)
Escapes special characters ("$" and "\").
rtl_bootstrap_setIniFileName
SAL_DLLPUBLIC void rtl_bootstrap_setIniFileName(rtl_uString *pFileUri)
may be called by an application to set an ini-filename.
rtl_bootstrap_expandMacros_from_handle
SAL_DLLPUBLIC void rtl_bootstrap_expandMacros_from_handle(rtlBootstrapHandle handle, rtl_uString **macro)
Expands a macro using bootstrap variables.
rtl_bootstrap_get
SAL_DLLPUBLIC sal_Bool rtl_bootstrap_get(rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault)
rtl_bootstrap_args_close
SAL_DLLPUBLIC void rtl_bootstrap_args_close(rtlBootstrapHandle handle) SAL_THROW_EXTERN_C()
Closes a bootstrap argument container.
rtl_bootstrap_get_iniName_from_handle
SAL_DLLPUBLIC void rtl_bootstrap_get_iniName_from_handle(rtlBootstrapHandle handle, rtl_uString **ppIniName)
Returns the name of the inifile associated with this handle.
rtlBootstrapHandle
void * rtlBootstrapHandle
Definition: bootstrap.h:149
rtl_bootstrap_get_from_handle
SAL_DLLPUBLIC sal_Bool rtl_bootstrap_get_from_handle(rtlBootstrapHandle handle, rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault)
rtl_bootstrap_args_open
SAL_DLLPUBLIC rtlBootstrapHandle rtl_bootstrap_args_open(rtl_uString *pIniName)
Opens a bootstrap argument container.
rtl_bootstrap_expandMacros
SAL_DLLPUBLIC void rtl_bootstrap_expandMacros(rtl_uString **macro)
Expands a macro using default bootstrap variables.
rtl_bootstrap_set
SAL_DLLPUBLIC void rtl_bootstrap_set(rtl_uString *pName, rtl_uString *pValue)
Sets a bootstrap parameter.