Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

 Overview   Namespace   Class   Index   Help 

Methods of Class OUStringBuffer

OUStringBuffer
OUStringBuffer();

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

Summary
Constructs a string buffer with no characters in it and an initial capacity of 16 characters.
OUStringBuffer
OUStringBuffer(
const OUStringBuffer & value );

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

Summary
Allocates a new string buffer that contains the same sequence of characters as the string buffer argument.
Parameters
value 
a OStringBuffer.
OUStringBuffer
OUStringBuffer(
sal_Int32 length );

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

Summary
Constructs a string buffer with no characters in it and an initial capacity specified by the length argument.
Parameters
length 
the initial capacity.
OUStringBuffer
OUStringBuffer(
OUString value );

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

Summary
Constructs a string buffer so that it represents the same sequence of characters as the string argument.
Description
The initial capacity of the string buffer is 16 plus the length of the string argument.
Parameters
str 
the initial contents of the buffer.
operator=
OUStringBuffer & operator=(
const OUStringBuffer & value );

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

Summary
Assign to this a copy of value.
~OUStringBuffer
~OUStringBuffer();

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

Summary
Release the string data.
makeStringAndClear
OUString makeStringAndClear();

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

Summary
Fill the string data in the new string and clear the buffer.
Description
This method is more efficient than the contructor of the string. It does not copy the buffer.
Return
the string previously contained in the buffer.
getLength
sal_Int32 getLength();

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

Summary
Returns the length (character count) of this string buffer.
Return
the number of characters in this string buffer.
getCapacity
sal_Int32 getCapacity();

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

Summary
Returns the current capacity of the String buffer.
Description
The capacity is the amount of storage available for newly inserted characters. The real buffer size is 2 bytes longer, because all strings are 0 terminated.
Return
the current capacity of this string buffer.
ensureCapacity
void ensureCapacity(
sal_Int32 minimumCapacity );

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

Summary
Ensures that the capacity of the buffer is at least equal to the specified minimum.
Description
The new capacity will be at least as large as the maximum of the current length (so that no contents of the buffer is destroyed) and the given minimumCapacity. If the given minimumCapacity is negative, nothing is changed.
Parameters
minimumCapacity 
the minimum desired capacity.
setLength
void setLength(
sal_Int32 newLength );

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

Summary
Sets the length of this String buffer.
Description
If the newLength argument is less than the current length of the string buffer, the string buffer is truncated to contain exactly the number of characters given by the newLength argument.

If the newLength argument is greater than or equal to the current length, sufficient null characters ('\u0000') are appended to the string buffer so that length becomes the newLength argument.

The newLength argument must be greater than or equal to 0.

Parameters
newLength 
the new length of the buffer.
charAt
sal_Unicode charAt(
sal_Int32 index ) const;

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

Summary
Returns the character at a specific index in this string buffer.
Description
The first character of a string buffer is at index 0, the next at index 1, and so on, for array indexing.

The index argument must be greater than or equal to 0, and less than the length of this string buffer.

Parameters
index 
the index of the desired character.
Return
the character at the specified index of this string buffer.
operator const sal_Unicode *
operator const sal_Unicode *();

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

Summary
Return a null terminated unicode character array.
getStr
const sal_Unicode * getStr();

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

Summary
Return a null terminated unicode character array.
setCharAt
OUStringBuffer & setCharAt(
sal_Int32 index,
sal_Unicode ch );

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

Summary
The character at the specified index of this string buffer is set to ch.
Description
The index argument must be greater than or equal to 0, and less than the length of this string buffer.
Parameters
index 
the index of the character to modify.
ch 
the new character.
append
OUStringBuffer & append(
const OUString & str );

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

Summary
Appends the string to this string buffer.
Description
The characters of the String argument are appended, in order, to the contents of this string buffer, increasing the length of this string buffer by the length of the argument.
Parameters
str 
a string.
Return
this string buffer.
append
OUStringBuffer & append(
const sal_Unicode * str );

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

Summary
Appends the string representation of the char array argument to this string buffer.
Description
The characters of the array argument are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the length of the argument.
Parameters
str 
the characters to be appended.
Return
this string buffer.
append
OUStringBuffer & append(
const sal_Unicode * str,
sal_Int32 len );

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

Summary
Appends the string representation of the char array argument to this string buffer.
Description
Characters of the character array str are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the value of len.
Parameters
str 
the characters to be appended; must be non-null, and must
point to at least len characters
len 
the number of characters to append; must be non-negative
Return
this string buffer.
appendAscii
OUStringBuffer & appendAscii(
const sal_Char * str );

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

Summary
Appends a 8-Bit ASCII character string to this string buffer.
Description
Since this method is optimized for performance. the ASCII character values are not converted in any way. The caller has to make sure that all ASCII characters are in the allowed range between 0 and 127. The ASCII string must be NULL-terminated.

The characters of the array argument are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the length of the argument.

Parameters
str 
the 8-Bit ASCII characters to be appended.
Return
this string buffer.
appendAscii
OUStringBuffer & appendAscii(
const sal_Char * str,
sal_Int32 len );

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

Summary
Appends a 8-Bit ASCII character string to this string buffer.
Description
Since this method is optimized for performance. the ASCII character values are not converted in any way. The caller has to make sure that all ASCII characters are in the allowed range between 0 and 127. The ASCII string must be NULL-terminated.

Characters of the character array str are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the value of len.

Parameters
str 
the 8-Bit ASCII characters to be appended; must be non-null,
        and must point to at least len characters
len 
the number of characters to append; must be non-negative
Return
this string buffer.
append
OUStringBuffer & append(
sal_Bool b );

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

Summary
Appends the string representation of the sal_Bool argument to the string buffer.
Description
The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.
Parameters
b 
a sal_Bool.
Return
this string buffer.
append
OUStringBuffer & append(
sal_Unicode c );

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

Summary
Appends the string representation of the char argument to this string buffer.
Description
The argument is appended to the contents of this string buffer. The length of this string buffer increases by 1.
Parameters
ch 
a char.
Return
this string buffer.
append
OUStringBuffer & append(
sal_Int32 i,
sal_Int16 radix = 10 );

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

Summary
Appends the string representation of the sal_Int32 argument to this string buffer.
Description
The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.
Parameters
i 
an sal_Int32.
Return
this string buffer.
append
OUStringBuffer & append(
sal_Int64 l,
sal_Int16 radix = 10 );

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

Summary
Appends the string representation of the long argument to this string buffer.
Description
The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.
Parameters
l 
a long.
Return
this string buffer.
append
OUStringBuffer & append(
float f );

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

Summary
Appends the string representation of the float argument to this string buffer.
Description
The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.
Parameters
f 
a float.
Return
this string buffer.
append
OUStringBuffer & append(
double d );

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

Summary
Appends the string representation of the double argument to this string buffer.
Description
The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.
Parameters
d 
a double.
Return
this string buffer.
appendUtf32
OUStringBuffer & appendUtf32(
sal_uInt32 c );

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

Summary
Appends a single UTF-32 character to this string buffer.
Description

The single UTF-32 character will be represented within the string buffer as either one or two UTF-16 code units.

Parameters
c 
a well-formed UTF-32 code unit (that is, a value in the range
       0–0x10FFFF, but excluding
       0xD800–0xDFFF)
Return
this string buffer
insert
OUStringBuffer & insert(
sal_Int32 offset,
const OUString & str );

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

Summary
Inserts the string into this string buffer.
Description
The characters of the String argument are inserted, in order, into this string buffer at the indicated offset. The length of this string buffer is increased by the length of the argument.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
str 
a string.
Return
this string buffer.
insert
OUStringBuffer & insert(
sal_Int32 offset,
const sal_Unicode * str );

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

Summary
Inserts the string representation of the char array argument into this string buffer.
Description
The characters of the array argument are inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer increases by the length of the argument.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
ch 
a character array.
Return
this string buffer.
insert
OUStringBuffer & insert(
sal_Int32 offset,
const sal_Unicode * str,
sal_Int32 len );

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

Summary
Inserts the string representation of the char array argument into this string buffer.
Description
The characters of the array argument are inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer increases by the length of the argument.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
ch 
a character array.
len 
the number of characters to append.
Return
this string buffer.
insert
OUStringBuffer & insert(
sal_Int32 offset,
sal_Bool b );

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

Summary
Inserts the string representation of the sal_Bool argument into this string buffer.
Description
The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
b 
a sal_Bool.
Return
this string buffer.
insert
OUStringBuffer & insert(
sal_Int32 offset,
sal_Unicode c );

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

Summary
Inserts the string representation of the char argument into this string buffer.
Description
The second argument is inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer increases by one.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
ch 
a char.
Return
this string buffer.
insert
OUStringBuffer & insert(
sal_Int32 offset,
sal_Int32 i,
sal_Int16 radix = 10 );

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

Summary
Inserts the string representation of the second sal_Int32 argument into this string buffer.
Description
The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
b 
an sal_Int32.
Return
this string buffer.
insert
OUStringBuffer & insert(
sal_Int32 offset,
sal_Int64 l,
sal_Int16 radix = 10 );

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

Summary
Inserts the string representation of the long argument into this string buffer.
Description
The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
b 
a long.
Return
this string buffer.
insert
OUStringBuffer insert(
sal_Int32 offset,
float f );

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

Summary
Inserts the string representation of the float argument into this string buffer.
Description
The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
b 
a float.
Return
this string buffer.
insert
OUStringBuffer & insert(
sal_Int32 offset,
double d );

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

Summary
Inserts the string representation of the double argument into this string buffer.
Description
The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this string buffer.

Parameters
offset 
the offset.
b 
a double.
Return
this string buffer.
insertUtf32
OUStringBuffer & insertUtf32(
sal_Int32 offset,
sal_uInt32 c );

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

Summary
Inserts a single UTF-32 character into this string buffer.
Description

The single UTF-32 character will be represented within the string buffer as either one or two UTF-16 code units.

Parameters
offset 
the offset into this string buffer (from zero to the length
       of this string buffer, inclusive)
c 
a well-formed UTF-32 code unit (that is, a value in the range
       0–0x10FFFF, but excluding
       0xD800–0xDFFF)
Return
this string buffer
accessInternals
void accessInternals(
rtl_uString * * * pInternalData,
sal_Int32 * * pInternalCapacity );

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

Summary
Allows access to the internal data of this OUStringBuffer, for effective manipulation.
Description
This method should be used with care. After you have called this method, you may use the returned pInternalData or pInternalCapacity only as long as you make no other method call on this OUStringBuffer.
Parameters
pInternalData 
This output parameter receives a pointer to the internal data
(rtl_uString pointer).  pInternalData itself must not be null.
pInternalCapacity 
This output parameter receives a pointer to the internal capacity.
pInternalCapacity itself must not be null.
Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.