Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Methods of Class Environment


Environment
Environment(
uno_Environment * pEnv = 0 ) throw();

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

Summary
Constructor: acquires given environment

Parameters
pEnv
environment

Environment
explicit Environment(
const rtl::OUString & envDcp,
void * pContext = NULL ) throw();

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

Summary
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

Environment
Environment(
const Environment & rEnv ) throw();

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

Summary
Copy constructor: acquires given environment

Parameters
rEnv
another environment

~Environment
~Environment() throw();

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

Summary
Destructor: releases a set environment.

operator=
Environment & operator=(
uno_Environment * pEnv ) throw();

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

Summary
Sets a given environment, i.e. acquires given one and releases a set one.

Parameters
pEnv
another environment
Return
this environment

operator=
Environment & operator=(
const Environment & rEnv ) throw();

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

Summary
Sets a given environment, i.e. acquires given one and releases a set one.

Parameters
rEnv
another environment
Return
this environment

get
uno_Environment * get() throw();

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

Summary
Provides UNacquired pointer to the set C environment.

Return
UNacquired pointer to the C environment struct

getTypeName
::rtl::OUString getTypeName() throw();

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

Summary
Gets type name of set environment.

Return
type name of set environment

getContext
void * getContext() throw();

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

Summary
Gets free context pointer of set environment.

Return
free context pointer of set environment

is
sal_Bool is() throw();

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

Summary
Tests if a environment is set.

Return
true, if a environment is set, false otherwise

clear
void clear() throw();

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

Summary
Releases a set environment.

invoke_v
void invoke_v(
uno_EnvCallee * pCallee,
va_list * pParam ) const throw();

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

Summary
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

invoke
void invoke(
uno_EnvCallee * pCallee,
... ) const throw();

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

Summary
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

enter
void enter() throw();

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

Summary
Enter this environment explicitly. 

Since
UDK 3.2.7

isValid
int isValid(
rtl::OUString * pReason ) const throw();

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

Summary
Checks, if it is valid to currently call objects 
belonging to this environment.

Since
UDK 3.2.7

getCurrent
static Environment getCurrent(
const rtl::OUString & typeName = rtl :: OUString RTL_CONSTASCII_USTRINGPARAM CPPU_STRINGIFY CPPU_ENV ) throw();

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

Summary
Returns the current Environment.

Parameters
env_type
the optional type of the Environment, falls back to "uno" in case being empty,
                          respectively to current C++ Environment.
        
Since
UDK 3.2.7

Top of Page

Apache Software Foundation

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

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