The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Global Functions in Global Namespace C++
in Sourcefile environment.h


uno_Environment_enter
extern "C"
void uno_Environment_enter(
uno_Environment * pEnv );

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

Summary
Enter an environment explicitly. 

Parameters
pEnv
the environment to enter; NULL leaves all environments
    
Since
UDK 3.2.7

uno_Environment_invoke
extern "C"
void uno_Environment_invoke(
uno_Environment * pEnv,
uno_EnvCallee * pCallee,
... );

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

Summary
Invoke the passed function in the given environment. 

Parameters
pEnv
the target environment
    
pCallee
the function to call
    
...
the parameters passed to the function
    
Since
UDK 3.2.7

uno_Environment_invoke_v
extern "C"
void uno_Environment_invoke_v(
uno_Environment * pEnv,
uno_EnvCallee * pCallee,
va_list * pParam );

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

Summary
Invoke the passed function in the given environment.

Parameters
pEnv
the target environment
    
pCallee
the function to call
    
pParam
the parameter pointer passed to the function
    
Since
UDK 3.2.7

uno_Environment_isValid
extern "C"
int uno_Environment_isValid(
uno_Environment * pEnv,
rtl_uString * * pReason );

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

Summary
Check if a particular environment is currently valid, so
that objects of that environment might be called.

Parameters
pEnv
the environment
rtl_uString
** pReason  the reason, if it is not valid
Return
1 == valid, 0 == invalid
Since
UDK 3.2.7

uno_createEnvironment
extern "C"
void uno_createEnvironment(
uno_Environment * * ppEnv,
rtl_uString * pEnvDcp,
void * pContext );

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

Summary
Creates an environment. The new environment is anonymous (NOT publicly registered/ accessible).

Parameters
ppEnv
out parameter of environment; given environment will be released
pEnvDcp
descriptor of environment
pContext
context pointer (e.g., to distinguish java vm); set 0 if not needed

uno_dumpEnvironment
extern "C"
void uno_dumpEnvironment(
void * stream,
uno_Environment * pEnv,
const sal_Char * pFilter );

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

Summary
Dumps out environment information, i.e. registered interfaces.

Parameters
stream
output stream (FILE *)
pEnv
environment to be dumped
pFilter
if not null, filters output

uno_dumpEnvironmentByName
extern "C"
void uno_dumpEnvironmentByName(
void * stream,
rtl_uString * pEnvDcp,
const sal_Char * pFilter );

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

Summary
Dumps out environment information, i.e. registered interfaces.

Parameters
stream
output stream (FILE *)
pEnvDcp
descritpro of environment to be dumped
pFilter
if not null, filters output

uno_getCurrentEnvironment
extern "C"
void uno_getCurrentEnvironment(
uno_Environment * * ppEnv,
rtl_uString * pTypeName );

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

Description
Returns the current Environment.
In case no Environment has explicitly been entered, a purpose free
default environment gets returned (e.g. the "uno" or "gcc3" Environment).

Parameters
ppEnv
inout parameter; a given environment will be released
pTypeName
the optional type of the environment, falls back to "uno"
Since
UDK 3.2.7

uno_getEnvironment
extern "C"
void uno_getEnvironment(
uno_Environment * * ppEnv,
rtl_uString * pEnvDcp,
void * pContext );

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

Summary
Gets a specific environment. If the specified environment does not exist, then a default one
is created and registered. The environment revokes itself on last release() call.

Parameters
ppEnv
inout parameter of environment; given environment will be released
pEnvDcp
descriptor of environment
pContext
some context pointer (e.g., to distinguish java vm; set 0 if not needed)

uno_getRegisteredEnvironments
extern "C"
void uno_getRegisteredEnvironments(
uno_Environment * * * pppEnvs,
sal_Int32 * pnLen,
uno_memAlloc memAlloc,
rtl_uString * pEnvDcp );

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

Summary
Gets all specified environments. Caller has to release returned environments and free allocated
memory.

Parameters
pppEnvs
out param; pointer to array of environments
pnLen
out param; length of array
memAlloc
function for allocating memory that is passed back
pEnvDcp
descriptor of environments; 0 defaults to all

Top of Page

Apache Software Foundation

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

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. 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.