Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.11

API

SDK

Tips ‘n’ Tricks

Miscellaneous


Methods of Class Bootstrap


Bootstrap
Bootstrap();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
default ctor.

Bootstrap
Bootstrap(
const OUString & iniName );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Opens a bootstrap argment container
See Also
rtl_bootstrap_args_open()

~Bootstrap
~Bootstrap();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Closes a bootstrap argument container
See Also
rtl_bootstrap_args_close()

getFrom
sal_Bool getFrom(
const ::rtl::OUString & sName,
::rtl::OUString & outValue ) const;

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Retrieves a bootstrap argument.
Description
It is first tried to retrieve the value via the global function and second via the special bootstrap container.
See Also
rtl_bootstrap_get_from_handle()

getFrom
void getFrom(
const ::rtl::OUString & sName,
::rtl::OUString & outValue,
const ::rtl::OUString & aDefault ) const;

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Retrieves a bootstrap argument.
Description
It is first tried to retrieve the value via the global function and second via the special bootstrap container.
See Also
rtl_bootstrap_get_from_handle()

getIniName
void getIniName(
::rtl::OUString & iniName ) const;

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Retrieves the name of the underlying ini-file.
See Also
rtl_bootstrap_get_iniName_from_handle()

expandMacrosFrom
void expandMacrosFrom(
::rtl::OUString & macro ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Expands a macro using bootstrap variables.
Parameters
macro
The macro to be expanded

getHandle
rtlBootstrapHandle getHandle() throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Provides the bootstrap internal handle.
Return
bootstrap handle

setIniFilename
static void setIniFilename(
const ::rtl::OUString & sFile );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES YES NO

See Also
rtl_bootstrap_setIniFileName()

get
static sal_Bool get(
const ::rtl::OUString & sName,
::rtl::OUString & outValue );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES YES NO

Summary
Retrieves a bootstrap parameter
Parameters
sName
name of the bootstrap value. case insensitive.
outValue
(out parameter). On success contains the value, otherwise
       an empty string.
Return
sal_False, if no value could be retrieved, otherwise sal_True
See Also
rtl_bootstrap_get()

get
static void get(
const ::rtl::OUString & sName,
::rtl::OUString & outValue,
const ::rtl::OUString & aDefault );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES YES NO

Summary
Retrieves a bootstrap parameter
Parameters
sName
name of the bootstrap value. case insensitive.
outValue
(out parameter). Contains the value associated with sName.
aDefault
if none of the other methods retrieved a value, outValue
                is assigned to a Default.
       
See Also
rtl_bootstrap_get()

set
static void set(
const ::rtl::OUString & name,
const ::rtl::OUString & value ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES YES NO

Summary
Sets a bootstrap parameter.
Parameters
pName
       name of bootstrap parameter
pValue
       value of bootstrap parameter

See Also
rtl_bootstrap_set()

expandMacros
static void expandMacros(
::rtl::OUString & macro ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES YES NO

Summary
Expands a macro using default bootstrap variables.
Parameters
macro
The macro to be expanded

encode
static ::rtl::OUString encode(
const ::rtl::OUString & value ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES YES NO

Summary
Escapes special characters ("$" and "\").
Parameters
value
            an arbitrary value

            
Return
the given value, with all occurences of special characters ("$" and "\") escaped
Since
UDK 3.2.9

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.