UDK 3.2.7 C/C++ API Reference
Public Member Functions | Static Public Member Functions
rtl::Bootstrap Class Reference

#include <bootstrap.hxx>

List of all members.

Public Member Functions

 Bootstrap ()
 default ctor.
 Bootstrap (const OUString &iniName)
 Opens a bootstrap argment container.
 ~Bootstrap ()
 Closes a bootstrap argument container.
sal_Bool getFrom (const ::rtl::OUString &sName,::rtl::OUString &outValue) const
 Retrieves a bootstrap argument.
void getFrom (const ::rtl::OUString &sName,::rtl::OUString &outValue, const ::rtl::OUString &aDefault) const
 Retrieves a bootstrap argument.
void getIniName (::rtl::OUString &iniName) const
 Retrieves the name of the underlying ini-file.
void expandMacrosFrom (::rtl::OUString &macro) const throw ()
 Expands a macro using bootstrap variables.
rtlBootstrapHandle getHandle () const throw ()
 Provides the bootstrap internal handle.

Static Public Member Functions

static void setIniFilename (const ::rtl::OUString &sFileUri)
static sal_Bool get (const ::rtl::OUString &sName,::rtl::OUString &outValue)
 Retrieves a bootstrap parameter.
static void get (const ::rtl::OUString &sName,::rtl::OUString &outValue, const ::rtl::OUString &aDefault)
 Retrieves a bootstrap parameter.
static void set (::rtl::OUString const &name,::rtl::OUString const &value) throw ()
 Sets a bootstrap parameter.
static void expandMacros (::rtl::OUString &macro) throw ()
 Expands a macro using default bootstrap variables.
static inline::rtl::OUString encode (::rtl::OUString const &value) throw ()
 Escapes special characters ("$" and "\").

Constructor & Destructor Documentation

rtl::Bootstrap::Bootstrap ( ) [inline]

default ctor.

rtl::Bootstrap::Bootstrap ( const OUString iniName) [inline]

Opens a bootstrap argment container.

See also:
rtl_bootstrap_args_open()
rtl::Bootstrap::~Bootstrap ( ) [inline]

Closes a bootstrap argument container.

See also:
rtl_bootstrap_args_close()

Member Function Documentation

rtl::OUString rtl::Bootstrap::encode ( ::rtl::OUString const &  value) throw () [inline, static]

Escapes special characters ("$" and "\").

Parameters:
valuean arbitrary value
Returns:
the given value, with all occurrences of special characters ("$" and "\") escaped
Since:
UDK 3.2.9
static void rtl::Bootstrap::expandMacros ( ::rtl::OUString macro) throw () [inline, static]

Expands a macro using default bootstrap variables.

Parameters:
macro[inout] The macro to be expanded
void rtl::Bootstrap::expandMacrosFrom ( ::rtl::OUString macro) const throw () [inline]

Expands a macro using bootstrap variables.

Parameters:
macro[inout] The macro to be expanded
sal_Bool rtl::Bootstrap::get ( const ::rtl::OUString sName,
::rtl::OUString outValue 
) [inline, static]

Retrieves a bootstrap parameter.

Parameters:
sNamename of the bootstrap value. case insensitive.
outValue(out parameter). On success contains the value, otherwise an empty string.
Returns:
sal_False, if no value could be retrieved, otherwise sal_True
See also:
rtl_bootstrap_get()
void rtl::Bootstrap::get ( const ::rtl::OUString sName,
::rtl::OUString outValue,
const ::rtl::OUString aDefault 
) [inline, static]

Retrieves a bootstrap parameter.

Parameters:
sNamename of the bootstrap value. case insensitive.
outValue(out parameter). Contains the value associated with sName.
aDefaultif none of the other methods retrieved a value, outValue is assigned to a Default.
See also:
rtl_bootstrap_get()
sal_Bool rtl::Bootstrap::getFrom ( const ::rtl::OUString sName,
::rtl::OUString outValue 
) const [inline]

Retrieves a bootstrap argument.

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()
void rtl::Bootstrap::getFrom ( const ::rtl::OUString sName,
::rtl::OUString outValue,
const ::rtl::OUString aDefault 
) const [inline]

Retrieves a bootstrap argument.

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()
rtlBootstrapHandle rtl::Bootstrap::getHandle ( ) const throw () [inline]

Provides the bootstrap internal handle.

Returns:
bootstrap handle
void rtl::Bootstrap::getIniName ( ::rtl::OUString iniName) const [inline]

Retrieves the name of the underlying ini-file.

See also:
rtl_bootstrap_get_iniName_from_handle()
void rtl::Bootstrap::set ( ::rtl::OUString const &  name,
::rtl::OUString const &  value 
) throw () [inline, static]

Sets a bootstrap parameter.

Parameters:
namename of bootstrap parameter
valuevalue of bootstrap parameter
See also:
rtl_bootstrap_set()
void rtl::Bootstrap::setIniFilename ( const ::rtl::OUString sFileUri) [inline, static]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines