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 data.h


uno_assignData
extern "C"
sal_Bool uno_assignData(
void * pDest,
_typelib_TypeDescription * pDestTypeDescr,
void * pSource,
_typelib_TypeDescription * pSourceTypeDescr,
uno_QueryInterfaceFunc queryInterface,
uno_AcquireFunc acquire,
uno_ReleaseFunc release );

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

Description
Assigns a destination value with a source value.
Widening conversion WITHOUT data loss is allowed (e.g., assigning a long with a short).
Querying for demanded interface type is allowed.
Assignment from any value to a value of type Any and vice versa is allowed.

Parameters
pDest
pointer to destination value
pDestTypeDescr
type description of destination value
pSource
pointer to source value; if 0, then destination value will be assigned
                        to default value
pSourceTypeDescr
type destination of source value
queryInterface
function called each time an interface needs to be queried;
                        defaults (0) to uno
acquire
function called each time an interface needs to be acquired;
                        defaults (0) to uno
release
function called each time an interface needs to be released;
                        defaults (0) to uno
Return
true if destination has been successfully assigned

uno_constructData
extern "C"
void uno_constructData(
void * pMem,
_typelib_TypeDescription * pTypeDescr );

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

Summary
Default constructs a value. All simple types are set to 0, enums are set to their default value.

Parameters
pMem
pointer to memory of value to be constructed
pTypeDescr
type description of value to be constructed

uno_copyAndConvertData
extern "C"
void uno_copyAndConvertData(
void * pDest,
void * pSource,
_typelib_TypeDescription * pTypeDescr,
_uno_Mapping * mapping );

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

Summary
Copy construct memory with given value. The size of the destination value must be larger
or equal to the size of the source value. Interfaces are converted/ mapped by mapping parameter.

Parameters
pDest
pointer to destination value memory
pSource
pointer to source value
pTypeDescr
type description of source
mapping
mapping to convert/ map interfaces

uno_copyData
extern "C"
void uno_copyData(
void * pDest,
void * pSource,
_typelib_TypeDescription * pTypeDescr,
uno_AcquireFunc acquire );

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

Summary
Copy construct memory with given value. The size of the destination value must be larger
or equal to the size of the source value.

Parameters
pDest
pointer to destination value memory
pSource
pointer to source value
pTypeDescr
type description of source
acquire
function called each time an interface needs to be acquired;
                        defaults (0) to uno

uno_destructData
extern "C"
void uno_destructData(
void * pValue,
_typelib_TypeDescription * pTypeDescr,
uno_ReleaseFunc release );

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

Summary
Destructs a given value; does NOT free its memory!

Parameters
pValue
value to be destructed
pTypeDescr
type description of value
release
function called each time an interface pointer needs to be released;
                        defaults (0) to uno

uno_equalData
extern "C"
sal_Bool uno_equalData(
void * pVal1,
_typelib_TypeDescription * pVal1TypeDescr,
void * pVal2,
_typelib_TypeDescription * pVal2TypeDescr,
uno_QueryInterfaceFunc queryInterface,
uno_ReleaseFunc release );

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

Summary
Tests if two values are equal. May compare different types (e.g., short to long).

Parameters
pVal1
pointer to a value
pVal1TypeDescr
type description of pVal1
pVal2
pointer to another value
pVal2TypeDescr
type description of pVal2
queryInterface
function called each time two interfaces are tested whether they belong
                        to the same object; defaults (0) to uno
release
function to release queried interfaces; defaults (0) to uno
Return
true if values are equal

uno_type_assignData
extern "C"
sal_Bool uno_type_assignData(
void * pDest,
_typelib_TypeDescriptionReference * pDestType,
void * pSource,
_typelib_TypeDescriptionReference * pSourceType,
uno_QueryInterfaceFunc queryInterface,
uno_AcquireFunc acquire,
uno_ReleaseFunc release );

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

Description
Assigns a destination value with a source value.
Widening conversion WITHOUT data loss is allowed (e.g., assigning a long with a short).
Querying for demanded interface type is allowed.
Assignment from any value to a value of type Any and vice versa is allowed.

Parameters
pDest
pointer to destination value
pDestType
type of destination value
pSource
pointer to source value; if 0, then destination value will be assigned
                        to default value
pSourceType
type of source value
queryInterface
function called each time an interface needs to be queried;
                        defaults (0) to uno
acquire
function called each time an interface needs to be acquired;
                        defaults (0) to uno
release
function called each time an interface needs to be released;
                        defaults (0) to uno
Return
true if destination has been successfully assigned

uno_type_constructData
extern "C"
void uno_type_constructData(
void * pMem,
_typelib_TypeDescriptionReference * pType );

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

Summary
Default constructs a value. All simple types are set to 0, enums are set to their default value.

Parameters
pMem
pointer to memory of value to be constructed
pType
type of value to be constructed

uno_type_copyAndConvertData
extern "C"
void uno_type_copyAndConvertData(
void * pDest,
void * pSource,
_typelib_TypeDescriptionReference * pType,
_uno_Mapping * mapping );

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

Summary
Copy construct memory with given value. The size of the destination value must be larger
or equal to the size of the source value. Interfaces are converted/ mapped by mapping parameter.

Parameters
pDest
pointer to destination value memory
pSource
pointer to source value
pType
type of source
mapping
mapping to convert/ map interfaces

uno_type_copyData
extern "C"
void uno_type_copyData(
void * pDest,
void * pSource,
_typelib_TypeDescriptionReference * pType,
uno_AcquireFunc acquire );

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

Summary
Copy construct memory with given value. The size of the destination value must be larger
or equal to the size of the source value.

Parameters
pDest
pointer to destination value memory
pSource
pointer to source value
pType
type of source
acquire
function called each time an interface needs to be acquired;
                        defaults (0) to uno

uno_type_destructData
extern "C"
void uno_type_destructData(
void * pValue,
_typelib_TypeDescriptionReference * pType,
uno_ReleaseFunc release );

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

Summary
Destructs a given value; does NOT free its memory!

Parameters
pValue
value to be destructed
pType
type of value
release
function called each time an interface pointer needs to be released;
                        defaults (0) to uno

uno_type_equalData
extern "C"
sal_Bool uno_type_equalData(
void * pVal1,
_typelib_TypeDescriptionReference * pVal1Type,
void * pVal2,
_typelib_TypeDescriptionReference * pVal2Type,
uno_QueryInterfaceFunc queryInterface,
uno_ReleaseFunc release );

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

Summary
Tests if two values are equal. May compare different types (e.g., short to long).

Parameters
pVal1
pointer to a value
pVal1Type
type of pVal1
pVal2
pointer to another value
pVal2Type
type of pVal2
queryInterface
function called each time two interfaces are tested whether they belong
                        to the same object; defaults (0) to uno
release
function to release queried interfaces; defaults (0) to uno
Return
true if values are equal

uno_type_isAssignableFromData
extern "C"
sal_Bool uno_type_isAssignableFromData(
_typelib_TypeDescriptionReference * pAssignable,
void * pFrom,
_typelib_TypeDescriptionReference * pFromType,
uno_QueryInterfaceFunc queryInterface,
uno_ReleaseFunc release );

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

Description
Tests whether a value of given type is assignable from given value.
Widening conversion WITHOUT data loss is allowed (e.g., assigning a long with a short).
Querying for demanded interface type is allowed.
Assignment from any value to a value of type Any and vice versa is allowed.

Parameters
pAssignable
type
pFrom
pointer to value
pFromType
type of value
queryInterface
function called each time an interface needs to be queried;
                        defaults (0) to uno
release
function called each time an interface needs to be released;
                        defaults (0) to uno
Return
true if value is destination has been successfully assigned

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.