LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Attributes | List of all members
_uno_ExtEnvironment Struct Reference

The binary specification of an UNO environment supporting interface registration. More...

#include <environment.h>

Public Attributes

uno_Environment aBase
 inherits all members of an uno_Environment More...
 
void(* registerInterface )(struct _uno_ExtEnvironment *pEnv, void **ppInterface, rtl_uString *pOId, struct _typelib_InterfaceTypeDescription *pTypeDescr)
 Registers an interface of this environment. More...
 
void(* registerProxyInterface )(struct _uno_ExtEnvironment *pEnv, void **ppProxy, uno_freeProxyFunc freeProxy, rtl_uString *pOId, struct _typelib_InterfaceTypeDescription *pTypeDescr)
 Registers a proxy interface of this environment that can be reanimated and is freed explicitly by this environment. More...
 
void(* revokeInterface )(struct _uno_ExtEnvironment *pEnv, void *pInterface)
 Revokes an interface from this environment. More...
 
void(* getObjectIdentifier )(struct _uno_ExtEnvironment *pEnv, rtl_uString **ppOId, void *pInterface)
 Provides the object id of a given interface. More...
 
void(* getRegisteredInterface )(struct _uno_ExtEnvironment *pEnv, void **ppInterface, rtl_uString *pOId, struct _typelib_InterfaceTypeDescription *pTypeDescr)
 Retrieves an interface identified by its object id and type from this environment. More...
 
void(* getRegisteredInterfaces )(struct _uno_ExtEnvironment *pEnv, void ***pppInterfaces, sal_Int32 *pnLen, uno_memAlloc memAlloc)
 Returns all currently registered interfaces of this environment. More...
 
void(* computeObjectIdentifier )(struct _uno_ExtEnvironment *pEnv, rtl_uString **ppOId, void *pInterface)
 Computes an object id of the given interface; is called by the environment implementation. More...
 
void(* acquireInterface )(struct _uno_ExtEnvironment *pEnv, void *pInterface)
 Function to acquire an interface. More...
 
void(* releaseInterface )(struct _uno_ExtEnvironment *pEnv, void *pInterface)
 Function to release an interface. More...
 

Detailed Description

The binary specification of an UNO environment supporting interface registration.

Member Data Documentation

uno_Environment _uno_ExtEnvironment::aBase

inherits all members of an uno_Environment

void( * _uno_ExtEnvironment::acquireInterface)(struct _uno_ExtEnvironment *pEnv, void *pInterface)

Function to acquire an interface.

Parameters
pEnvcorresponding environment
pInterfacean interface
void( * _uno_ExtEnvironment::computeObjectIdentifier)(struct _uno_ExtEnvironment *pEnv, rtl_uString **ppOId, void *pInterface)

Computes an object id of the given interface; is called by the environment implementation.

Parameters
pEnvcorresponding environment
ppOIdout param: computed id
pInterfacean interface
void( * _uno_ExtEnvironment::getObjectIdentifier)(struct _uno_ExtEnvironment *pEnv, rtl_uString **ppOId, void *pInterface)

Provides the object id of a given interface.

Parameters
ppOutinout oid
pInterfaceinterface of object
void( * _uno_ExtEnvironment::getRegisteredInterface)(struct _uno_ExtEnvironment *pEnv, void **ppInterface, rtl_uString *pOId, struct _typelib_InterfaceTypeDescription *pTypeDescr)

Retrieves an interface identified by its object id and type from this environment.

Interfaces are retrieved in the same order as they are registered.

Parameters
pEnvthis environment
ppInterfaceinout parameter for the registered interface; (0) if none was found
pOIdobject id of interface to be retrieved
pTypeDescrtype description of interface to be retrieved
void( * _uno_ExtEnvironment::getRegisteredInterfaces)(struct _uno_ExtEnvironment *pEnv, void ***pppInterfaces, sal_Int32 *pnLen, uno_memAlloc memAlloc)

Returns all currently registered interfaces of this environment.

The memory block allocated might be slightly larger than (*pnLen * sizeof(void *)).

Parameters
pEnvthis environment
pppInterfacesout param; pointer to array of interface pointers
pnLenout param; length of array
memAllocfunction for allocating memory that is passed back
void( * _uno_ExtEnvironment::registerInterface)(struct _uno_ExtEnvironment *pEnv, void **ppInterface, rtl_uString *pOId, struct _typelib_InterfaceTypeDescription *pTypeDescr)

Registers an interface of this environment.

Parameters
pEnvthis environment
ppInterfaceinout parameter of interface to be registered
pOIdobject id of interface
pTypeDescrtype description of interface
void( * _uno_ExtEnvironment::registerProxyInterface)(struct _uno_ExtEnvironment *pEnv, void **ppProxy, uno_freeProxyFunc freeProxy, rtl_uString *pOId, struct _typelib_InterfaceTypeDescription *pTypeDescr)

Registers a proxy interface of this environment that can be reanimated and is freed explicitly by this environment.

Parameters
pEnvthis environment
ppInterfaceinout parameter of interface to be registered
freeProxyfunction to free proxy object
pOIdobject id of interface
pTypeDescrtype description of interface
void( * _uno_ExtEnvironment::releaseInterface)(struct _uno_ExtEnvironment *pEnv, void *pInterface)

Function to release an interface.

Parameters
pEnvcorresponding environment
pInterfacean interface
void( * _uno_ExtEnvironment::revokeInterface)(struct _uno_ExtEnvironment *pEnv, void *pInterface)

Revokes an interface from this environment.

You have to revoke any interface that has been registered via this method.

Parameters
pEnvthis environment
pInterfaceinterface to be revoked

The documentation for this struct was generated from the following file: