LibreOffice
LibreOffice 6.0 SDK C/C++ API Reference
Typedefs | Functions
sequence2.h File Reference
#include <cppu/cppudllapi.h>
#include <uno/data.h>

Go to the source code of this file.

Typedefs

typedef sal_Sequence uno_Sequence
 

Functions

CPPU_DLLPUBLIC void uno_sequence_assign (uno_Sequence **ppDest, uno_Sequence *pSource, struct _typelib_TypeDescription *pTypeDescr, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
 Assigns a sequence. More...
 
CPPU_DLLPUBLIC void uno_type_sequence_assign (uno_Sequence **ppDest, uno_Sequence *pSource, struct _typelib_TypeDescriptionReference *pType, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
 Assigns a sequence. More...
 
CPPU_DLLPUBLIC sal_Bool uno_sequence_construct (uno_Sequence **ppSequence, struct _typelib_TypeDescription *pTypeDescr, void *pElements, sal_Int32 len, uno_AcquireFunc acquire) SAL_THROW_EXTERN_C()
 Constructs a new sequence with given elements. More...
 
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_construct (uno_Sequence **ppSequence, struct _typelib_TypeDescriptionReference *pType, void *pElements, sal_Int32 len, uno_AcquireFunc acquire) SAL_THROW_EXTERN_C()
 Constructs a new sequence with given elements. More...
 
CPPU_DLLPUBLIC sal_Bool uno_sequence_reference2One (uno_Sequence **ppSequence, struct _typelib_TypeDescription *pTypeDescr, uno_AcquireFunc acquire, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
 Assures that the reference count of the given sequence is one. More...
 
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_reference2One (uno_Sequence **ppSequence, struct _typelib_TypeDescriptionReference *pType, uno_AcquireFunc acquire, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
 Assures that the reference count of the given sequence is one. More...
 
CPPU_DLLPUBLIC sal_Bool uno_sequence_realloc (uno_Sequence **ppSequence, struct _typelib_TypeDescription *pTypeDescr, sal_Int32 nSize, uno_AcquireFunc acquire, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
 Reallocates length of a sequence. More...
 
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_realloc (uno_Sequence **ppSequence, struct _typelib_TypeDescriptionReference *pType, sal_Int32 nSize, uno_AcquireFunc acquire, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
 Reallocates length of a sequence. More...
 
CPPU_DLLPUBLIC void uno_type_sequence_destroy (uno_Sequence *sequence, struct _typelib_TypeDescriptionReference *type, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
 Destroy a sequence whose reference count has dropped to zero. More...
 

Typedef Documentation

Function Documentation

CPPU_DLLPUBLIC void uno_sequence_assign ( uno_Sequence **  ppDest,
uno_Sequence pSource,
struct _typelib_TypeDescription pTypeDescr,
uno_ReleaseFunc  release 
)

Assigns a sequence.

Parameters
ppDestdestinstaion sequence
pSourcesource sequence
pTypeDescrtype description of the sequence and NOT of an element
releasefunction called each time an interface needs to be released; defaults (0) to uno
CPPU_DLLPUBLIC sal_Bool uno_sequence_construct ( uno_Sequence **  ppSequence,
struct _typelib_TypeDescription pTypeDescr,
void *  pElements,
sal_Int32  len,
uno_AcquireFunc  acquire 
)

Constructs a new sequence with given elements.

Parameters
ppSequenceout parameter sequence; 0 if memory allocation has failed
pTypeDescrtype description of the sequence and NOT of an element
pElementsif 0, then all elements are default constructed
lennumber of elements
acquirefunction called each time an interface needs to be acquired; defaults (0) to uno
Returns
false, if memoray allocation has failed
CPPU_DLLPUBLIC sal_Bool uno_sequence_realloc ( uno_Sequence **  ppSequence,
struct _typelib_TypeDescription pTypeDescr,
sal_Int32  nSize,
uno_AcquireFunc  acquire,
uno_ReleaseFunc  release 
)

Reallocates length of a sequence.

This truncates a sequence or enlarges it default constructing appended elements.

Parameters
ppSequenceinout sequence
pTypeDescrtype description of sequence
nSizenew size of sequence
acquirefunction called each time an interface needs to be acquired; defaults (0) to uno
releasefunction called each time an interface needs to be released; defaults (0) to uno
Returns
false, if memoray allocation has failed
CPPU_DLLPUBLIC sal_Bool uno_sequence_reference2One ( uno_Sequence **  ppSequence,
struct _typelib_TypeDescription pTypeDescr,
uno_AcquireFunc  acquire,
uno_ReleaseFunc  release 
)

Assures that the reference count of the given sequence is one.

Otherwise a new copy of the sequence is created with a reference count of one.

Parameters
ppSequenceinout sequence
pTypeDescrtype description of sequence
acquirefunction called each time an interface needs to be acquired; defaults (0) to uno
releasefunction called each time an interface needs to be released; defaults (0) to uno
Returns
false, if memoray allocation has failed
CPPU_DLLPUBLIC void uno_type_sequence_assign ( uno_Sequence **  ppDest,
uno_Sequence pSource,
struct _typelib_TypeDescriptionReference pType,
uno_ReleaseFunc  release 
)

Assigns a sequence.

Parameters
ppDestdestinstaion sequence
pSourcesource sequence
pTypetype of the sequence and NOT of an element
releasefunction called each time an interface needs to be released; defaults (0) to uno
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_construct ( uno_Sequence **  ppSequence,
struct _typelib_TypeDescriptionReference pType,
void *  pElements,
sal_Int32  len,
uno_AcquireFunc  acquire 
)

Constructs a new sequence with given elements.

Parameters
ppSequenceout parameter sequence; 0 if memory allocation has failed
pTypetype of the sequence and NOT of an element
pElementsif 0, then all elements are default constructed
lennumber of elements
acquirefunction called each time an interface needs to be acquired; defaults (0) to uno
Returns
false, if memoray allocation has failed
CPPU_DLLPUBLIC void uno_type_sequence_destroy ( uno_Sequence sequence,
struct _typelib_TypeDescriptionReference type,
uno_ReleaseFunc  release 
)

Destroy a sequence whose reference count has dropped to zero.

Parameters
sequencemust be non-null, sequence->nRefCount must be zero
typethe type of the sequence, must be non-null
releasefunction called each time an interface needs to be release, must be non-null
Since
LibreOffice 4.4
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_realloc ( uno_Sequence **  ppSequence,
struct _typelib_TypeDescriptionReference pType,
sal_Int32  nSize,
uno_AcquireFunc  acquire,
uno_ReleaseFunc  release 
)

Reallocates length of a sequence.

This truncates a sequence or enlarges it default constructing appended elements.

Parameters
ppSequenceinout sequence
pTypetype of sequence
nSizenew size of sequence
acquirefunction called each time an interface needs to be acquired; defaults (0) to uno
releasefunction called each time an interface needs to be released; defaults (0) to uno
Returns
false, if memoray allocation has failed
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_reference2One ( uno_Sequence **  ppSequence,
struct _typelib_TypeDescriptionReference pType,
uno_AcquireFunc  acquire,
uno_ReleaseFunc  release 
)

Assures that the reference count of the given sequence is one.

Otherwise a new copy of the sequence is created with a reference count of one.

Parameters
ppSequenceinout sequence
pTypetype of sequence
acquirefunction called each time an interface needs to be acquired; defaults (0) to uno
releasefunction called each time an interface needs to be released; defaults (0) to uno
Returns
false, if memoray allocation has failed