LibreOffice LibreOffice 4.1 SDK C/C++ API Reference

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

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 _RTL_BOOTSTRAP_H_
20 #define _RTL_BOOTSTRAP_H_
21
22 #include "sal/config.h"
23
24 #include "rtl/ustring.h"
25 #include "sal/saldllapi.h"
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
121 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_setIniFileName( rtl_uString *pFileUri )
122 SAL_THROW_EXTERN_C();
123
141 SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_bootstrap_get(
142 rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault )
143 SAL_THROW_EXTERN_C();
144
152 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_set(
153 rtl_uString * pName, rtl_uString * pValue )
154 SAL_THROW_EXTERN_C();
155
156
157 typedef void * rtlBootstrapHandle;
158
165 SAL_DLLPUBLIC rtlBootstrapHandle SAL_CALL rtl_bootstrap_args_open(rtl_uString * pIniName)
166 SAL_THROW_EXTERN_C();
167
172 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_args_close(rtlBootstrapHandle handle)
173 SAL_THROW_EXTERN_C();
174
183 SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_bootstrap_get_from_handle(
184 rtlBootstrapHandle handle, rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault)
185 SAL_THROW_EXTERN_C();
186
187
193 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_get_iniName_from_handle(
194 rtlBootstrapHandle handle, rtl_uString ** ppIniName)
195 SAL_THROW_EXTERN_C();
196
202 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_expandMacros_from_handle(
203 rtlBootstrapHandle handle, rtl_uString ** macro )
204 SAL_THROW_EXTERN_C();
209 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_expandMacros(
210 rtl_uString ** macro )
211 SAL_THROW_EXTERN_C();
212
224 SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_encode(
225 rtl_uString const * value, rtl_uString ** encoded )
226 SAL_THROW_EXTERN_C();
227
228 #ifdef __cplusplus
229 }
230 #endif
231
232 #endif
233
234 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
rtl_bootstrap_expandMacros
SAL_DLLPUBLIC void rtl_bootstrap_expandMacros(rtl_uString **macro) SAL_THROW_EXTERN_C()
Expands a macro using default bootstrap variables.
SAL_THROW_EXTERN_C
#define SAL_THROW_EXTERN_C()
Definition: types.h:358
rtl_bootstrap_encode
SAL_DLLPUBLIC void rtl_bootstrap_encode(rtl_uString const *value, rtl_uString **encoded) SAL_THROW_EXTERN_C()
Escapes special characters ("$" and "\").
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
rtl_bootstrap_get
SAL_DLLPUBLIC sal_Bool rtl_bootstrap_get(rtl_uString *pName, rtl_uString **ppValue, rtl_uString *pDefault) SAL_THROW_EXTERN_C()
saldllapi.h
rtl_bootstrap_set
SAL_DLLPUBLIC void rtl_bootstrap_set(rtl_uString *pName, rtl_uString *pValue) SAL_THROW_EXTERN_C()
Sets a bootstrap parameter.
rtl_bootstrap_setIniFileName
SAL_DLLPUBLIC void rtl_bootstrap_setIniFileName(rtl_uString *pFileUri) SAL_THROW_EXTERN_C()
may be called by an application to set an ini-filename.
rtl_bootstrap_args_open
SAL_DLLPUBLIC rtlBootstrapHandle rtl_bootstrap_args_open(rtl_uString *pIniName) SAL_THROW_EXTERN_C()
Opens a bootstrap argument container.
rtl_bootstrap_get_iniName_from_handle
SAL_DLLPUBLIC void rtl_bootstrap_get_iniName_from_handle(rtlBootstrapHandle handle, rtl_uString **ppIniName) SAL_THROW_EXTERN_C()
Returns the name of the inifile associated with this handle.
config.h
rtl_bootstrap_args_close
SAL_DLLPUBLIC void rtl_bootstrap_args_close(rtlBootstrapHandle handle) SAL_THROW_EXTERN_C()
Closes a boostrap agument container.
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) SAL_THROW_EXTERN_C()
rtl_bootstrap_expandMacros_from_handle
SAL_DLLPUBLIC void rtl_bootstrap_expandMacros_from_handle(rtlBootstrapHandle handle, rtl_uString **macro) SAL_THROW_EXTERN_C()
Expands a macro using bootstrap variables.
sal_Bool
unsigned char sal_Bool
Definition: types.h:37
rtlBootstrapHandle
void * rtlBootstrapHandle
Definition: bootstrap.h:157
ustring.h