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


rtl_byte_sequence_acquire
extern "C"
void rtl_byte_sequence_acquire(
sal_Sequence * pSequence );

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

Summary
Acquires the byte sequence
Parameters
pSequence
sequence, that is to be acquired

rtl_byte_sequence_assign
extern "C"
void rtl_byte_sequence_assign(
sal_Sequence * * ppSequence,
sal_Sequence * pSequence );

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

Summary
Assigns the byte sequence pSequence to *ppSequence.
Parameters
ppSequence
inout sequence; on entry *ppSequence may be null, otherwise it is released;
                  after the call, *ppSequence references pSequence
pSequence
the source sequence 

rtl_byte_sequence_construct
extern "C"
void rtl_byte_sequence_construct(
sal_Sequence * * ppSequence,
sal_Int32 nLength );

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

Summary
Constructs a bytes sequence with length nLength. All bytes are set to zero.
Parameters
ppSequence
inout sequence; on entry *ppSequence may be null, otherwise it is released;
                  after the call, *ppSequence contains the newly constructed sequence
nLength
length of new sequence

rtl_byte_sequence_constructFromArray
extern "C"
void rtl_byte_sequence_constructFromArray(
sal_Sequence * * ppSequence,
const sal_Int8 * pData,
sal_Int32 nLength );

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

Summary
Constructs a byte sequence with length nLength and copies nLength bytes from pData.
Parameters
ppSequence
inout sequence; on entry *ppSequence may be null, otherwise it is released;
                      after the call, *ppSequence contains the newly constructed sequence
    
pData
initial data
    
nLength
length of new sequence

rtl_byte_sequence_constructNoDefault
extern "C"
void rtl_byte_sequence_constructNoDefault(
sal_Sequence * * ppSequence,
sal_Int32 nLength );

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

Summary
Constructs a bytes sequence with length nLength. The data is not initialized.
Parameters
ppSequence
inout sequence; on entry *ppSequence may be null, otherwise it is released;
                  after the call, *ppSequence contains the newly constructed sequence
nLength
length of new sequence

rtl_byte_sequence_equals
extern "C"
sal_Bool rtl_byte_sequence_equals(
sal_Sequence * pSequence1,
sal_Sequence * pSequence2 );

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

Summary
Compares two byte sequences.
Return
true, if the data within the sequences are identical; false otherwise

rtl_byte_sequence_getConstArray
extern "C"
const sal_Int8 * rtl_byte_sequence_getConstArray(
sal_Sequence * pSequence );

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

Summary
Returns the data array pointer of the sequence.
Return
read-pointer to the data array of the sequence. If rtl_byte_sequence_reference2One() has been called before, the pointer may be casted to a non const pointer and the sequence may be modified

rtl_byte_sequence_getLength
extern "C"
sal_Int32 rtl_byte_sequence_getLength(
sal_Sequence * pSequence );

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

Summary
Returns the length of the sequence
Parameters
pSequence
sequence handle
Return
length of the sequence

rtl_byte_sequence_realloc
extern "C"
void rtl_byte_sequence_realloc(
sal_Sequence * * ppSequence,
sal_Int32 nSize );

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

Summary
Reallocates length of byte sequence.
Parameters
ppSequence
sequence
nSize
new size of sequence

rtl_byte_sequence_reference2One
extern "C"
void rtl_byte_sequence_reference2One(
sal_Sequence * * ppSequence );

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

Summary
Assures that the reference count of the given byte sequence is one. Otherwise a new copy of the sequence is created with a reference count of one.
Parameters
ppSequence
sequence

rtl_byte_sequence_release
extern "C"
void rtl_byte_sequence_release(
sal_Sequence * pSequence );

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

Summary
Releases the byte sequence. If the refcount drops to zero, the sequence is freed.
Parameters
pSequence
sequence, that is to be released; invalid after call

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.