C++ wrapper for binary C uno_Environment.
More...
#include <environment.hxx>
List of all members.
Detailed Description
C++ wrapper for binary C uno_Environment.
- See also:
- uno_Environment
Constructor & Destructor Documentation
com::sun::star::uno::Environment::Environment |
( |
uno_Environment * |
pEnv = 0 | ) |
throw () [inline] |
Constructor: acquires given environment.
- Parameters:
-
com::sun::star::uno::Environment::Environment |
( |
rtl::OUString const & |
envDcp, |
|
|
void * |
pContext = NULL |
|
) |
| throw () [inline, explicit] |
Gets a specific environment.
If the specified environment does not exist, then a default one is created and registered.
- Parameters:
-
envDcp | descriptor of the environment |
pContext | context pointer |
com::sun::star::uno::Environment::Environment |
( |
const Environment & |
rEnv | ) |
throw () [inline] |
Copy constructor: acquires given environment.
- Parameters:
-
com::sun::star::uno::Environment::~Environment |
( |
| ) |
throw () [inline] |
Destructor: releases a set environment.
Member Function Documentation
void com::sun::star::uno::Environment::clear |
( |
| ) |
throw () [inline] |
Releases a set environment.
void com::sun::star::uno::Environment::enter |
( |
| ) |
const throw () [inline] |
Enter this environment explicitly.
- Since:
- UDK 3.2.7
uno_Environment* com::sun::star::uno::Environment::get |
( |
| ) |
const throw () [inline] |
Provides UNacquired pointer to the set C environment.
- Returns:
- UNacquired pointer to the C environment struct
void* com::sun::star::uno::Environment::getContext |
( |
| ) |
const throw () [inline] |
Gets free context pointer of set environment.
- Returns:
- free context pointer of set environment
Environment com::sun::star::uno::Environment::getCurrent |
( |
rtl::OUString const & |
typeName = rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(CPPU_STRINGIFY(CPPU_ENV))) | ) |
throw () [inline, static] |
Returns the current Environment.
- Parameters:
-
typeName | the optional type of the Environment, falls back to "uno" in case being empty, respectively to current C++ Environment. |
- Since:
- UDK 3.2.7
inline ::rtl::OUString com::sun::star::uno::Environment::getTypeName |
( |
| ) |
const throw () [inline] |
Gets type name of set environment.
- Returns:
- type name of set environment
void com::sun::star::uno::Environment::invoke |
( |
uno_EnvCallee * |
pCallee, |
|
|
|
... |
|
) |
| const throw () [inline] |
Invoke the passed function in this environment.
- Parameters:
-
pCallee | the function to call |
... | the parameters to be passed to the function |
- Since:
- UDK 3.2.7
void com::sun::star::uno::Environment::invoke_v |
( |
uno_EnvCallee * |
pCallee, |
|
|
va_list * |
pParam |
|
) |
| const throw () [inline] |
Invoke the passed function in this environment.
- Parameters:
-
pCallee | the function to call |
pParam | the parameter pointer to be passed to the function |
- Since:
- UDK 3.2.7
sal_Bool com::sun::star::uno::Environment::is |
( |
| ) |
const throw () [inline] |
Tests if a environment is set.
- Returns:
- true, if a environment is set, false otherwise
int com::sun::star::uno::Environment::isValid |
( |
rtl::OUString * |
pReason | ) |
const throw () [inline] |
Checks, if it is valid to currently call objects belonging to this environment.
- Since:
- UDK 3.2.7
Sets a given environment, i.e.
acquires given one and releases a set one.
- Parameters:
-
- Returns:
- this environment
Sets a given environment, i.e.
acquires given one and releases a set one.
- Parameters:
-
- Returns:
- this environment
The documentation for this class was generated from the following file: