Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: uno ::

class Environment


Base Classes
None.
Known Derived Classes
None.

virtual abstract interface template
NO NO NO NO
Summary
C++ wrapper for binary C uno_Environment.

See Also
uno_Environment
File
environment.hxx

Public Members

Methods


Environment( uno_Environment * pEnv = 0 ) throw( );
Constructor: acquires given environment
explicit
Environment( const rtl::OUString & envDcp, void * pContext = NULL ) throw( );
Gets a specific environment. If the specified environment does not exist, then a default one is created and registered.

Environment( const Environment & rEnv ) throw( );
Copy constructor: acquires given environment

~Environment( ) throw( );
Destructor: releases a set environment.
Environment &
operator=( uno_Environment * pEnv ) throw( );
Sets a given environment, i.e. acquires given one and releases a set one.
Environment &
operator=( const Environment & rEnv ) throw( );
Sets a given environment, i.e. acquires given one and releases a set one.
uno_Environment *
get( ) const throw( );
Provides UNacquired pointer to the set C environment.
::rtl::OUString
getTypeName( ) const throw( );
Gets type name of set environment.
void *
getContext( ) const throw( );
Gets free context pointer of set environment.
sal_Bool
is( ) const throw( );
Tests if a environment is set.
void
clear( ) throw( );
Releases a set environment.
void
invoke_v( uno_EnvCallee * pCallee, va_list * pParam ) const throw( );
Invoke the passed function in this environment.
void
invoke( uno_EnvCallee * pCallee, ... ) const throw( );
Invoke the passed function in this environment.
void
enter( ) const throw( );
Enter this environment explicitly.
int
isValid( rtl::OUString * pReason ) const throw( );
Checks, if it is valid to currently call objects belonging to this environment.

Static Methods

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

Private Members

Data

uno_Environment * _pEnv; binary C uno_Environment

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.