Overview | Namespace | Class | Index | Help

## Global Functions in Global Namespace C++
in Sourcefile bootstrap.h

rtl_bootstrap_args_close
  extern "C"
  void rtl_bootstrap_args_close(

    rtlBootstrapHandle | handle );

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

  Summary
    Closes a boostrap agument container.
  Parameters

    handle |
        The handle got by rtl_bootstrap_args_open()

rtl_bootstrap_args_open
  extern "C"
  rtlBootstrapHandle rtl_bootstrap_args_open(

    rtl_uString * | pIniName );

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

  Summary
    Opens a bootstrap argument container.
  Parameters

    pIniName |
        The name of the ini-file to use, if NULL defaults
                               to the excutables name

  Return
    Handle for a boostrap argument container

rtl_bootstrap_expandMacros
  extern "C"
  void rtl_bootstrap_expandMacros(

    rtl_uString * * | macro );

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

  Summary
    Expands a macro using default bootstrap variables.
  Parameters

    macro |
        The macro to be expanded

rtl_bootstrap_expandMacros_from_handle
  extern "C"
  void rtl_bootstrap_expandMacros_from_handle(

    rtlBootstrapHandle | handle,
    rtl_uString * * | macro );

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

  Summary
    Expands a macro using bootstrap variables.
  Parameters

    handle |
        The handle got by rtl_bootstrap_args_open()
    macro |
        The macro to be expanded

rtl_bootstrap_get
  extern "C"
  sal_Bool rtl_bootstrap_get(

    rtl_uString * | pName,
    rtl_uString * * | ppValue,
    rtl_uString * | pDefault );

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

  Parameters

    ppValue |
        out parameter. Contains always a valid rtl_uString pointer.
    pName |
                 The name of the bootstrap setting to be     retrieved.
    pDefault |
             maybe NULL. If once the default is
                returned, successive calls always return this
                default value, even when called with different
                defaults.

  Return
    `sal_True`, when a value could be retrieved successfully, `sal_False`, when none of the 4 methods gave a value. ppValue then contains ane empty string. When a pDefault value is given, the function returns always `sal_True`.

rtl_bootstrap_get_from_handle
  extern "C"
  sal_Bool rtl_bootstrap_get_from_handle(

    rtlBootstrapHandle | handle,
    rtl_uString * | pName,
    rtl_uString * * | ppValue,
    rtl_uString * | pDefault );

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

  Parameters

    handle |
        The handle got by rtl_bootstrap_args_open()
    pName |
        The name of the variable to be retrieved
    ppValue |
        The result of the retrieval. *ppValue may be null in case of failure.
    pDefault |
        The default value for the retrieval, may be NULL

  Return
    The status of the retrieval, `sal_True` on success.

rtl_bootstrap_get_iniName_from_handle
  extern "C"
  void rtl_bootstrap_get_iniName_from_handle(

    rtlBootstrapHandle | handle,
    rtl_uString * * | ppIniName );

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

  Summary
    Returns the name of the inifile associated with this handle.
  Parameters

    ppIniName |
        contains after the call the name of the ini-filename.

rtl_bootstrap_set
  extern "C"
  void rtl_bootstrap_set(

    rtl_uString * | pName,
    rtl_uString * | pValue );

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

  Summary
    Sets a bootstrap parameter.
  Parameters

    pName |
               name of bootstrap parameter
    pValue |
               value of bootstrap parameter

rtl_bootstrap_setIniFileName
  extern "C"
  void rtl_bootstrap_setIniFileName(

    rtl_uString * | pName );

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

  Summary
    may be called by an application to set an ini-filename.
  Description

    Must be called before rtl_bootstrap_get(). May not be called twice. If it is never called, a the filename executable.ini (win) or execuablerc (unx) is assumed.

  Parameters

    pName |
        Name of the inifile with path but WITHOUT
            suffix (.ini or rc)

Top of Page

Copyright © 2003 Sun Microsystems, Inc.