Files
libreoffice/cppu/inc/uno/sequence2.h
Rüdiger Timm 06e4e93a4c INTEGRATION: CWS ooo19126 (1.7.84); FILE MERGED
2005/09/05 13:54:19 rt 1.7.84.1: #i54170# Change license header: remove SISSL
2005-09-08 07:42:14 +00:00

200 lines
7.6 KiB
C

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: sequence2.h,v $
*
* $Revision: 1.8 $
*
* last change: $Author: rt $ $Date: 2005-09-08 08:42:13 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef _UNO_SEQUENCE2_H_
#define _UNO_SEQUENCE2_H_
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif
#ifndef _UNO_DATA_H_
#include <uno/data.h>
#endif
#ifdef __cplusplus
extern "C"
{
#endif
struct _typelib_TypeDescriptionReference;
struct _typelib_TypeDescription;
typedef sal_Sequence uno_Sequence;
/** Assigns a sequence.
@param ppDest destinstaion sequence
@param pSource source sequence
@param pTypeDescr type description of the sequence and NOT of an element
@param release function called each time an interface needs to
be released; defaults (0) to uno
*/
void SAL_CALL uno_sequence_assign(
uno_Sequence ** ppDest,
uno_Sequence * pSource,
struct _typelib_TypeDescription * pTypeDescr,
uno_ReleaseFunc release )
SAL_THROW_EXTERN_C();
/** Assigns a sequence.
@param ppDest destinstaion sequence
@param pSource source sequence
@param pType type of the sequence and NOT of an element
@param release function called each time an interface needs to
be released; defaults (0) to uno
*/
void SAL_CALL uno_type_sequence_assign(
uno_Sequence ** ppDest,
uno_Sequence * pSource,
struct _typelib_TypeDescriptionReference * pType,
uno_ReleaseFunc release )
SAL_THROW_EXTERN_C();
/** Constructs a new sequence with given elements.
@param ppSequence out parameter sequence;
0 if memory allocation has failed
@param pTypeDescr type description of the sequence and NOT of an
element
@param pElements if 0, then all elements are default constructed
@param len number of elements
@param acquire function called each time an interface needs to
be acquired; defaults (0) to uno
@return false, if memoray allocation has failed
*/
sal_Bool SAL_CALL 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.
@param ppSequence out parameter sequence;
0 if memory allocation has failed
@param pType type of the sequence and NOT of an element
@param pElements if 0, then all elements are default constructed
@param len number of elements
@param acquire function called each time an interface needs to
be acquired; defaults (0) to uno
@return false, if memoray allocation has failed
*/
sal_Bool SAL_CALL uno_type_sequence_construct(
uno_Sequence ** ppSequence,
struct _typelib_TypeDescriptionReference * pType,
void * pElements, sal_Int32 len,
uno_AcquireFunc acquire )
SAL_THROW_EXTERN_C();
/** 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.
@param ppSequence inout sequence
@param pTypeDescr type description of sequence
@param acquire function called each time an interface needs to
be acquired; defaults (0) to uno
@param release function called each time an interface needs to
be released; defaults (0) to uno
@return false, if memoray allocation has failed
*/
sal_Bool SAL_CALL 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.
Otherwise a new copy of the sequence is created with a reference count
of one.
@param ppSequence inout sequence
@param pType type of sequence
@param acquire function called each time an interface needs to
be acquired; defaults (0) to uno
@param release function called each time an interface needs to
be released; defaults (0) to uno
@return false, if memoray allocation has failed
*/
sal_Bool SAL_CALL uno_type_sequence_reference2One(
uno_Sequence ** ppSequence,
struct _typelib_TypeDescriptionReference * pType,
uno_AcquireFunc acquire,
uno_ReleaseFunc release )
SAL_THROW_EXTERN_C();
/** Reallocates length of a sequence. This truncates a sequence or enlarges
it default constructing appended elements.
@param ppSequence inout sequence
@param pTypeDescr type description of sequence
@param nSize new size of sequence
@param acquire function called each time an interface needs to
be acquired; defaults (0) to uno
@param release function called each time an interface needs to
be released; defaults (0) to uno
@return false, if memoray allocation has failed
*/
sal_Bool SAL_CALL 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. This truncates a sequence or enlarges
it default constructing appended elements.
@param ppSequence inout sequence
@param pType type of sequence
@param nSize new size of sequence
@param acquire function called each time an interface needs to
be acquired; defaults (0) to uno
@param release function called each time an interface needs to
be released; defaults (0) to uno
@return false, if memoray allocation has failed
*/
sal_Bool SAL_CALL uno_type_sequence_realloc(
uno_Sequence ** ppSequence,
struct _typelib_TypeDescriptionReference * pType,
sal_Int32 nSize,
uno_AcquireFunc acquire,
uno_ReleaseFunc release )
SAL_THROW_EXTERN_C();
#ifdef __cplusplus
}
#endif
#endif