ustring.h File Reference

#include "sal/config.h"
#include "osl/interlck.h"
#include "rtl/string.h"
#include "rtl/textenc.h"
#include "sal/saldllapi.h"
#include "sal/types.h"

Go to the source code of this file.

Macros
#define	RTL_USTR_MAX_VALUEOFBOOLEAN   RTL_STR_MAX_VALUEOFBOOLEAN
#define	RTL_USTR_MAX_VALUEOFCHAR   RTL_STR_MAX_VALUEOFCHAR
#define	RTL_USTR_MIN_RADIX   RTL_STR_MIN_RADIX
#define	RTL_USTR_MAX_RADIX   RTL_STR_MAX_RADIX
#define	RTL_USTR_MAX_VALUEOFINT32   RTL_STR_MAX_VALUEOFINT32
#define	RTL_USTR_MAX_VALUEOFINT64   RTL_STR_MAX_VALUEOFINT64
#define	RTL_USTR_MAX_VALUEOFUINT64   RTL_STR_MAX_VALUEOFUINT64
#define	RTL_USTR_MAX_VALUEOFFLOAT   RTL_STR_MAX_VALUEOFFLOAT
#define	RTL_USTR_MAX_VALUEOFDOUBLE   RTL_STR_MAX_VALUEOFDOUBLE
#define	RTL_CONSTASCII_USTRINGPARAM(constAsciiStr)
	Supply an ASCII string literal together with its length and text encoding. More...
#define	OSTRING_TO_OUSTRING_CVTFLAGS

Functions
SAL_DLLPUBLIC sal_Int32	rtl_ustr_getLength (const sal_Unicode *str) SAL_THROW_EXTERN_C()
	Return the length of a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_compare (const sal_Unicode *first, const sal_Unicode *second) SAL_THROW_EXTERN_C()
	Compare two strings. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_compare_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const sal_Unicode *second, sal_Int32 secondLen) SAL_THROW_EXTERN_C()
	Compare two strings. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_shortenedCompare_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const sal_Unicode *second, sal_Int32 secondLen, sal_Int32 shortenedLen) SAL_THROW_EXTERN_C()
	Compare two strings with a maximum count of characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_reverseCompare_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const sal_Unicode *second, sal_Int32 secondLen) SAL_THROW_EXTERN_C()
	Compare two strings from back to front. More...
SAL_DLLPUBLIC sal_Bool	rtl_ustr_asciil_reverseEquals_WithLength (const sal_Unicode *first, const char *second, sal_Int32 len) SAL_THROW_EXTERN_C()
	Compare two strings from back to front for equality. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_compareIgnoreAsciiCase (const sal_Unicode *first, const sal_Unicode *second) SAL_THROW_EXTERN_C()
	Compare two strings, ignoring the case of ASCII characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_compareIgnoreAsciiCase_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const sal_Unicode *second, sal_Int32 secondLen) SAL_THROW_EXTERN_C()
	Compare two strings, ignoring the case of ASCII characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_shortenedCompareIgnoreAsciiCase_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const sal_Unicode *second, sal_Int32 secondLen, sal_Int32 shortenedLen) SAL_THROW_EXTERN_C()
	Compare two strings with a maximum count of characters, ignoring the case of ASCII characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_ascii_compare (const sal_Unicode *first, const char *second) SAL_THROW_EXTERN_C()
	Compare two strings. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_ascii_compare_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const char *second) SAL_THROW_EXTERN_C()
	Compare two strings. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_ascii_shortenedCompare_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const char *second, sal_Int32 shortenedLen) SAL_THROW_EXTERN_C()
	Compare two strings with a maximum count of characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_asciil_reverseCompare_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const char *second, sal_Int32 secondLen) SAL_THROW_EXTERN_C()
	Compare two strings from back to front. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_ascii_compareIgnoreAsciiCase (const sal_Unicode *first, const char *second) SAL_THROW_EXTERN_C()
	Compare two strings, ignoring the case of ASCII characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const char *second) SAL_THROW_EXTERN_C()
	Compare two strings, ignoring the case of ASCII characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_ascii_compareIgnoreAsciiCase_WithLengths (sal_Unicode const *first, sal_Int32 firstLen, char const *second, sal_Int32 secondLen) SAL_THROW_EXTERN_C()
	Compare two strings, ignoring the case of ASCII characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_ascii_shortenedCompareIgnoreAsciiCase_WithLength (const sal_Unicode *first, sal_Int32 firstLen, const char *second, sal_Int32 shortenedLen) SAL_THROW_EXTERN_C()
	Compare two strings with a maximum count of characters, ignoring the case of ASCII characters. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_hashCode (const sal_Unicode *str) SAL_THROW_EXTERN_C()
	Return a hash code for a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_hashCode_WithLength (const sal_Unicode *str, sal_Int32 len) SAL_THROW_EXTERN_C()
	Return a hash code for a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_indexOfChar (const sal_Unicode *str, sal_Unicode ch) SAL_THROW_EXTERN_C()
	Search for the first occurrence of a character within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_indexOfChar_WithLength (const sal_Unicode *str, sal_Int32 len, sal_Unicode ch) SAL_THROW_EXTERN_C()
	Search for the first occurrence of a character within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_lastIndexOfChar (const sal_Unicode *str, sal_Unicode ch) SAL_THROW_EXTERN_C()
	Search for the last occurrence of a character within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_lastIndexOfChar_WithLength (const sal_Unicode *str, sal_Int32 len, sal_Unicode ch) SAL_THROW_EXTERN_C()
	Search for the last occurrence of a character within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_indexOfStr (const sal_Unicode *str, const sal_Unicode *subStr) SAL_THROW_EXTERN_C()
	Search for the first occurrence of a substring within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_indexOfStr_WithLength (const sal_Unicode *str, sal_Int32 len, const sal_Unicode *subStr, sal_Int32 subLen) SAL_THROW_EXTERN_C()
	Search for the first occurrence of a substring within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_indexOfAscii_WithLength (sal_Unicode const *str, sal_Int32 len, char const *subStr, sal_Int32 subLen) SAL_THROW_EXTERN_C()
	Search for the first occurrence of an ASCII substring within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_lastIndexOfStr (const sal_Unicode *str, const sal_Unicode *subStr) SAL_THROW_EXTERN_C()
	Search for the last occurrence of a substring within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_lastIndexOfStr_WithLength (const sal_Unicode *str, sal_Int32 len, const sal_Unicode *subStr, sal_Int32 subLen) SAL_THROW_EXTERN_C()
	Search for the last occurrence of a substring within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_lastIndexOfAscii_WithLength (sal_Unicode const *str, sal_Int32 len, char const *subStr, sal_Int32 subLen) SAL_THROW_EXTERN_C()
	Search for the last occurrence of an ASCII substring within a string. More...
SAL_DLLPUBLIC void	rtl_ustr_replaceChar (sal_Unicode *str, sal_Unicode oldChar, sal_Unicode newChar) SAL_THROW_EXTERN_C()
	Replace all occurrences of a single character within a string. More...
SAL_DLLPUBLIC void	rtl_ustr_replaceChar_WithLength (sal_Unicode *str, sal_Int32 len, sal_Unicode oldChar, sal_Unicode newChar) SAL_THROW_EXTERN_C()
	Replace all occurrences of a single character within a string. More...
SAL_DLLPUBLIC void	rtl_ustr_toAsciiLowerCase (sal_Unicode *str) SAL_THROW_EXTERN_C()
	Convert all ASCII uppercase letters to lowercase within a string. More...
SAL_DLLPUBLIC void	rtl_ustr_toAsciiLowerCase_WithLength (sal_Unicode *str, sal_Int32 len) SAL_THROW_EXTERN_C()
	Convert all ASCII uppercase letters to lowercase within a string. More...
SAL_DLLPUBLIC void	rtl_ustr_toAsciiUpperCase (sal_Unicode *str) SAL_THROW_EXTERN_C()
	Convert all ASCII lowercase letters to uppercase within a string. More...
SAL_DLLPUBLIC void	rtl_ustr_toAsciiUpperCase_WithLength (sal_Unicode *str, sal_Int32 len) SAL_THROW_EXTERN_C()
	Convert all ASCII lowercase letters to uppercase within a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_trim (sal_Unicode *str) SAL_THROW_EXTERN_C()
	Remove white space from both ends of a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_trim_WithLength (sal_Unicode *str, sal_Int32 len) SAL_THROW_EXTERN_C()
	Remove white space from both ends of the string. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_valueOfBoolean (sal_Unicode *str, sal_Bool b) SAL_THROW_EXTERN_C()
	Create the string representation of a boolean. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_valueOfChar (sal_Unicode *str, sal_Unicode ch) SAL_THROW_EXTERN_C()
	Create the string representation of a character. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_valueOfInt32 (sal_Unicode *str, sal_Int32 i, sal_Int16 radix) SAL_THROW_EXTERN_C()
	Create the string representation of an integer. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_valueOfInt64 (sal_Unicode *str, sal_Int64 l, sal_Int16 radix) SAL_THROW_EXTERN_C()
	Create the string representation of a long integer. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_valueOfUInt64 (sal_Unicode *str, sal_uInt64 l, sal_Int16 radix) SAL_THROW_EXTERN_C()
	Create the string representation of an unsigned long integer. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_valueOfFloat (sal_Unicode *str, float f) SAL_THROW_EXTERN_C()
	Create the string representation of a float. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_valueOfDouble (sal_Unicode *str, double d) SAL_THROW_EXTERN_C()
	Create the string representation of a double. More...
SAL_DLLPUBLIC sal_Bool	rtl_ustr_toBoolean (const sal_Unicode *str) SAL_THROW_EXTERN_C()
	Interpret a string as a boolean. More...
SAL_DLLPUBLIC sal_Int32	rtl_ustr_toInt32 (const sal_Unicode *str, sal_Int16 radix) SAL_THROW_EXTERN_C()
	Interpret a string as an integer. More...
SAL_DLLPUBLIC sal_uInt32	rtl_ustr_toUInt32 (const sal_Unicode *str, sal_Int16 radix) SAL_THROW_EXTERN_C()
	Interpret a string as an unsigned integer. More...
SAL_DLLPUBLIC sal_Int64	rtl_ustr_toInt64 (const sal_Unicode *str, sal_Int16 radix) SAL_THROW_EXTERN_C()
	Interpret a string as a long integer. More...
SAL_DLLPUBLIC sal_Int64	rtl_ustr_toInt64_WithLength (const sal_Unicode *str, sal_Int16 radix, sal_Int32 nStrLength) SAL_THROW_EXTERN_C()
	Interpret a string as a long integer. More...
SAL_DLLPUBLIC sal_uInt64	rtl_ustr_toUInt64 (const sal_Unicode *str, sal_Int16 radix) SAL_THROW_EXTERN_C()
	Interpret a string as an unsigned long integer. More...
SAL_DLLPUBLIC float	rtl_ustr_toFloat (const sal_Unicode *str) SAL_THROW_EXTERN_C()
	Interpret a string as a float. More...
SAL_DLLPUBLIC double	rtl_ustr_toDouble (const sal_Unicode *str) SAL_THROW_EXTERN_C()
	Interpret a string as a double. More...
SAL_DLLPUBLIC void	rtl_uString_acquire (rtl_uString *str) SAL_THROW_EXTERN_C() SAL_HOT
	Increment the reference count of a string. More...
SAL_DLLPUBLIC void	rtl_uString_release (rtl_uString *str) SAL_THROW_EXTERN_C() SAL_HOT
	Decrement the reference count of a string. More...
SAL_DLLPUBLIC void	rtl_uString_new (rtl_uString **newStr) SAL_THROW_EXTERN_C()
	Allocate a new string containing no characters. More...
SAL_DLLPUBLIC rtl_uString *	rtl_uString_alloc (sal_Int32 nLen) SAL_THROW_EXTERN_C()
	Allocate a new string containing space for a given number of characters. More...
SAL_DLLPUBLIC void	rtl_uString_new_WithLength (rtl_uString **newStr, sal_Int32 nLen) SAL_THROW_EXTERN_C()
	Allocate a new string containing space for a given number of characters. More...
SAL_DLLPUBLIC void	rtl_uString_newFromString (rtl_uString **newStr, const rtl_uString *value) SAL_THROW_EXTERN_C()
	Allocate a new string that contains a copy of another string. More...
SAL_DLLPUBLIC void	rtl_uString_newFromStr (rtl_uString **newStr, const sal_Unicode *value) SAL_THROW_EXTERN_C()
	Allocate a new string that contains a copy of a character array. More...
SAL_DLLPUBLIC void	rtl_uString_newFromStr_WithLength (rtl_uString **newStr, const sal_Unicode *value, sal_Int32 len) SAL_THROW_EXTERN_C()
	Allocate a new string that contains a copy of a character array. More...
SAL_DLLPUBLIC void	rtl_uString_newFromSubString (rtl_uString **newStr, const rtl_uString *from, sal_Int32 beginIndex, sal_Int32 count) SAL_THROW_EXTERN_C()
	Allocate a new string that is a substring of this string. More...
SAL_DLLPUBLIC void	rtl_uString_newFromAscii (rtl_uString **newStr, const char *value) SAL_THROW_EXTERN_C()
	Allocate a new string that contains a copy of a character array. More...
SAL_DLLPUBLIC void	rtl_uString_newFromLiteral (rtl_uString **newStr, const char *value, sal_Int32 len, sal_Int32 allocExtra) SAL_THROW_EXTERN_C()
	More...
SAL_DLLPUBLIC void	rtl_uString_newFromCodePoints (rtl_uString **newString, sal_uInt32 const *codePoints, sal_Int32 codePointCount) SAL_THROW_EXTERN_C()
	Allocate a new string from an array of Unicode code points. More...
SAL_DLLPUBLIC void	rtl_uString_assign (rtl_uString **str, rtl_uString *rightValue) SAL_THROW_EXTERN_C()
	Assign a new value to a string. More...
SAL_DLLPUBLIC sal_Int32	rtl_uString_getLength (const rtl_uString *str) SAL_THROW_EXTERN_C()
	Return the length of a string. More...
SAL_DLLPUBLIC sal_Unicode *	rtl_uString_getStr (rtl_uString *str) SAL_THROW_EXTERN_C()
	Return a pointer to the underlying character array of a string. More...
SAL_DLLPUBLIC void	rtl_uString_newConcat (rtl_uString **newStr, rtl_uString *left, rtl_uString *right) SAL_THROW_EXTERN_C()
	Create a new string that is the concatenation of two other strings. More...
SAL_DLLPUBLIC void	rtl_uString_newConcatAsciiL (rtl_uString **newString, rtl_uString *left, char const *right, sal_Int32 rightLength)
	Create a new string that is the concatenation of two other strings. More...
SAL_DLLPUBLIC void	rtl_uString_newConcatUtf16L (rtl_uString **newString, rtl_uString *left, sal_Unicode const *right, sal_Int32 rightLength)
	Create a new string that is the concatenation of two other strings. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceStrAt (rtl_uString **newStr, rtl_uString *str, sal_Int32 idx, sal_Int32 count, rtl_uString *subStr) SAL_THROW_EXTERN_C()
	Create a new string by replacing a substring of another string. More...
SAL_DLLPUBLIC void	rtl_uString_newReplace (rtl_uString **newStr, rtl_uString *str, sal_Unicode oldChar, sal_Unicode newChar) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a single character within another string. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceFirst (rtl_uString **newStr, rtl_uString *str, rtl_uString const *from, rtl_uString const *to, sal_Int32 *index) SAL_THROW_EXTERN_C()
	Create a new string by replacing the first occurrence of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceFirstAsciiL (rtl_uString **newStr, rtl_uString *str, char const *from, sal_Int32 fromLength, rtl_uString const *to, sal_Int32 *index) SAL_THROW_EXTERN_C()
	Create a new string by replacing the first occurrence of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceFirstToAsciiL (rtl_uString **newStr, rtl_uString *str, rtl_uString const *from, char const *to, sal_Int32 toLength, sal_Int32 *index) SAL_THROW_EXTERN_C()
	Create a new string by replacing the first occurrence of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceFirstAsciiLAsciiL (rtl_uString **newStr, rtl_uString *str, char const *from, sal_Int32 fromLength, char const *to, sal_Int32 toLength, sal_Int32 *index) SAL_THROW_EXTERN_C()
	Create a new string by replacing the first occurrence of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceFirstAsciiLUtf16L (rtl_uString **newStr, rtl_uString *str, char const *from, sal_Int32 fromLength, sal_Unicode const *to, sal_Int32 toLength, sal_Int32 *index) SAL_THROW_EXTERN_C()
	Create a new string by replacing the first occurrence of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceFirstUtf16LAsciiL (rtl_uString **newStr, rtl_uString *str, sal_Unicode const *from, sal_Int32 fromLength, char const *to, sal_Int32 toLength, sal_Int32 *index) SAL_THROW_EXTERN_C()
	Create a new string by replacing the first occurrence of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceFirstUtf16LUtf16L (rtl_uString **newStr, rtl_uString *str, sal_Unicode const *from, sal_Int32 fromLength, sal_Unicode const *to, sal_Int32 toLength, sal_Int32 *index) SAL_THROW_EXTERN_C()
	Create a new string by replacing the first occurrence of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceAll (rtl_uString **newStr, rtl_uString *str, rtl_uString const *from, rtl_uString const *to) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceAllFromIndex (rtl_uString **newStr, rtl_uString *str, rtl_uString const *from, rtl_uString const *to, sal_Int32 fromIndex) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceAllAsciiL (rtl_uString **newStr, rtl_uString *str, char const *from, sal_Int32 fromLength, rtl_uString const *to) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceAllToAsciiL (rtl_uString **newStr, rtl_uString *str, rtl_uString const *from, char const *to, sal_Int32 toLength) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceAllAsciiLAsciiL (rtl_uString **newStr, rtl_uString *str, char const *from, sal_Int32 fromLength, char const *to, sal_Int32 toLength) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceAllAsciiLUtf16L (rtl_uString **newStr, rtl_uString *str, char const *from, sal_Int32 fromLength, sal_Unicode const *to, sal_Int32 toLength) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceAllUtf16LAsciiL (rtl_uString **newStr, rtl_uString *str, sal_Unicode const *from, sal_Int32 fromLength, char const *to, sal_Int32 toLength) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newReplaceAllUtf16LUtf16L (rtl_uString **newStr, rtl_uString *str, sal_Unicode const *from, sal_Int32 fromLength, sal_Unicode const *to, sal_Int32 toLength) SAL_THROW_EXTERN_C()
	Create a new string by replacing all occurrences of a given substring with another substring. More...
SAL_DLLPUBLIC void	rtl_uString_newToAsciiLowerCase (rtl_uString **newStr, rtl_uString *str) SAL_THROW_EXTERN_C()
	Create a new string by converting all ASCII uppercase letters to lowercase within another string. More...
SAL_DLLPUBLIC void	rtl_uString_newToAsciiUpperCase (rtl_uString **newStr, rtl_uString *str) SAL_THROW_EXTERN_C()
	Create a new string by converting all ASCII lowercase letters to uppercase within another string. More...
SAL_DLLPUBLIC void	rtl_uString_newTrim (rtl_uString **newStr, rtl_uString *str) SAL_THROW_EXTERN_C()
	Create a new string by removing white space from both ends of another string. More...
SAL_DLLPUBLIC sal_Int32	rtl_uString_getToken (rtl_uString **newStr, rtl_uString *str, sal_Int32 token, sal_Unicode cTok, sal_Int32 idx) SAL_THROW_EXTERN_C()
	Create a new string by extracting a single token from another string. More...
SAL_DLLPUBLIC void	rtl_string2UString (rtl_uString **newStr, const char *str, sal_Int32 len, rtl_TextEncoding encoding, sal_uInt32 convertFlags) SAL_THROW_EXTERN_C()
	Create a new Unicode string by converting a byte string, using a specific text encoding. More...
SAL_DLLPUBLIC void	rtl_uString_intern (rtl_uString **newStr, rtl_uString *str) SAL_THROW_EXTERN_C()
	Return a canonical representation for a string. More...
SAL_DLLPUBLIC void	rtl_uString_internConvert (rtl_uString **newStr, const char *str, sal_Int32 len, rtl_TextEncoding encoding, sal_uInt32 convertFlags, sal_uInt32 *pInfo) SAL_THROW_EXTERN_C()
	Return a canonical representation for a string. More...
SAL_DLLPUBLIC sal_uInt32	rtl_uString_iterateCodePoints (rtl_uString const *string, sal_Int32 *indexUtf16, sal_Int32 incrementCodePoints)
	Iterate through a string based on code points instead of UTF-16 code units. More...
SAL_DLLPUBLIC sal_Bool	rtl_convertStringToUString (rtl_uString **target, char const *source, sal_Int32 length, rtl_TextEncoding encoding, sal_uInt32 flags) SAL_THROW_EXTERN_C()
	Converts a byte string to a Unicode string, signalling failure. More...
SAL_DLLPUBLIC void	rtl_uString_ensureCapacity (rtl_uString **str, sal_Int32 size) SAL_THROW_EXTERN_C()
	Ensure a string has enough space for a given number of characters. More...

Macro Definition Documentation

OSTRING_TO_OUSTRING_CVTFLAGS

#define OSTRING_TO_OUSTRING_CVTFLAGS

Value:

(RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MAPTOPRIVATE |\
                                         RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_DEFAULT |\
                                         RTL_TEXTTOUNICODE_FLAGS_INVALID_DEFAULT)

RTL_CONSTASCII_USTRINGPARAM

#define RTL_CONSTASCII_USTRINGPARAM

(

constAsciiStr

)

Value:

(&(constAsciiStr)[0]), \
    ((sal_Int32)(SAL_N_ELEMENTS(constAsciiStr)-1)), RTL_TEXTENCODING_ASCII_US

Supply an ASCII string literal together with its length and text encoding.

This macro can be used to compute (some of) the arguments in function calls like rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("foo")).

Parameters

constAsciiStr

must be an expression of type "(possibly cv-qualified reference to) array of (possibly cv-qualified) char." Each element of the referenced array must represent an ASCII value in the range 0x00–0x7F. The last element of the referenced array is not considered part of the represented ASCII string, and its value should be 0x00. Depending on where this macro is used, the nature of the supplied expression might be further restricted.

RTL_USTR_MAX_RADIX

#define RTL_USTR_MAX_RADIX   RTL_STR_MAX_RADIX

RTL_USTR_MAX_VALUEOFBOOLEAN

#define RTL_USTR_MAX_VALUEOFBOOLEAN   RTL_STR_MAX_VALUEOFBOOLEAN

RTL_USTR_MAX_VALUEOFCHAR

#define RTL_USTR_MAX_VALUEOFCHAR   RTL_STR_MAX_VALUEOFCHAR

RTL_USTR_MAX_VALUEOFDOUBLE

#define RTL_USTR_MAX_VALUEOFDOUBLE   RTL_STR_MAX_VALUEOFDOUBLE

RTL_USTR_MAX_VALUEOFFLOAT

#define RTL_USTR_MAX_VALUEOFFLOAT   RTL_STR_MAX_VALUEOFFLOAT

RTL_USTR_MAX_VALUEOFINT32

#define RTL_USTR_MAX_VALUEOFINT32   RTL_STR_MAX_VALUEOFINT32

RTL_USTR_MAX_VALUEOFINT64

#define RTL_USTR_MAX_VALUEOFINT64   RTL_STR_MAX_VALUEOFINT64

RTL_USTR_MAX_VALUEOFUINT64

#define RTL_USTR_MAX_VALUEOFUINT64   RTL_STR_MAX_VALUEOFUINT64

RTL_USTR_MIN_RADIX

#define RTL_USTR_MIN_RADIX   RTL_STR_MIN_RADIX

Function Documentation

rtl_convertStringToUString()

SAL_DLLPUBLIC sal_Bool rtl_convertStringToUString	(	rtl_uString **	target,
		char const *	source,
		sal_Int32	length,
		rtl_TextEncoding	encoding,
		sal_uInt32	flags
	)

Converts a byte string to a Unicode string, signalling failure.

Parameters

target	An out parameter receiving the converted string. Must not be null itself, and must contain either null or a pointer to a valid rtl_uString; the contents are unspecified if conversion fails (rtl_convertStringToUString returns false).
source	The byte string. May only be null if length is zero.
length	The length of the byte string. Must be non-negative.
encoding	The text encoding to convert from. Must be an octet encoding (i.e., rtl_isOctetTextEncoding(encoding) must return true).
flags	A combination of RTL_TEXTTOUNICODE_FLAGS that detail how to do the conversion (see rtl_convertTextToUnicode). RTL_TEXTTOUNICODE_FLAGS_FLUSH need not be included, it is implicitly assumed. Typical uses are either RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR | RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR | RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR (fail if a byte or multi-byte sequence cannot be converted from the source encoding) or OSTRING_TO_OUSTRING_CVTFLAGS (make a best efforts conversion).

Returns

True if the conversion succeeded, false otherwise.

Since

UDK 3.2.9

rtl_string2UString()

SAL_DLLPUBLIC void rtl_string2UString	(	rtl_uString **	newStr,
		const char *	str,
		sal_Int32	len,
		rtl_TextEncoding	encoding,
		sal_uInt32	convertFlags
	)

Create a new Unicode string by converting a byte string, using a specific text encoding.

The lengths of the byte string and the Unicode string may differ (e.g., for double-byte encodings, UTF-7, UTF-8).

If the length of the byte string is greater than zero, the reference count of the new string will be 1.

If an out-of-memory condition occurs, newStr will point to a null pointer upon return.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
str	a byte character array. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the byte character array.
encoding	the text encoding to use for conversion.
convertFlags	flags which control the conversion. Either use OSTRING_TO_OUSTRING_CVTFLAGS, or see http://udk.openoffice.org/cpp/man/spec/textconversion.html for more details.

rtl_ustr_ascii_compare()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_ascii_compare	(	const sal_Unicode *	first,
		const char *	second
	)

Compare two strings.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting. Both strings must be null-terminated.

Since this function 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 of 0 and 127, inclusive.

Parameters

first	the first null-terminated string to be compared.
second	the second null-terminated ASCII string which is compared with the first one.

Returns

0 if both substrings are equal, a value less than 0 if the first substring is less than the second substring, and a value greater than 0 if the first substring is greater than the second substring.

rtl_ustr_ascii_compare_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_ascii_compare_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const char *	second
	)

Compare two strings.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting.

Since this function 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 of 0 and 127, inclusive.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second null-terminated ASCII string which is compared with the first one.

Returns

0 if both substrings are equal, a value less than 0 if the first substring is less than the second substring, and a value greater than 0 if the first substring is greater than the second substring.

rtl_ustr_ascii_compareIgnoreAsciiCase()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_ascii_compareIgnoreAsciiCase	(	const sal_Unicode *	first,
		const char *	second
	)

Compare two strings, ignoring the case of ASCII characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A–Z) are interpreted as values between 97 and 122 (ASCII a–z). This function cannot be used for language-specific sorting. Both strings must be null-terminated.

Since this function 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 of 0 and 127, inclusive.

Parameters

first	the first null-terminated string to be compared.
second	the second null-terminated ASCII string which is compared with the first one.

Returns

0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string.

rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_ascii_compareIgnoreAsciiCase_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const char *	second
	)

Compare two strings, ignoring the case of ASCII characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A–Z) are interpreted as values between 97 and 122 (ASCII a–z). This function cannot be used for language-specific sorting.

Since this function 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 of 0 and 127, inclusive.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second null-terminated ASCII string which is compared with the first one.

Returns

0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string.

rtl_ustr_ascii_compareIgnoreAsciiCase_WithLengths()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_ascii_compareIgnoreAsciiCase_WithLengths	(	sal_Unicode const *	first,
		sal_Int32	firstLen,
		char const *	second,
		sal_Int32	secondLen
	)

Compare two strings, ignoring the case of ASCII characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A–Z) are interpreted as values between 97 and 122 (ASCII a–z). This function cannot be used for language-specific sorting.

Since this function 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 of 0 and 127, inclusive.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen.
secondLen	the length of the second string.

Returns

0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string.

rtl_ustr_ascii_shortenedCompare_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_ascii_shortenedCompare_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const char *	second,
		sal_Int32	shortenedLen
	)

Compare two strings with a maximum count of characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting.

Since this function 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 of 0 and 127, inclusive.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second null-terminated ASCII string which is compared with the first one.
shortenedLen	the maximum number of characters to compare. This length can be greater or smaller than the lengths of the two strings.

Returns

0 if both substrings are equal, a value less than 0 if the first substring is less than the second substring, and a value greater than 0 if the first substring is greater than the second substring.

rtl_ustr_ascii_shortenedCompareIgnoreAsciiCase_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_ascii_shortenedCompareIgnoreAsciiCase_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const char *	second,
		sal_Int32	shortenedLen
	)

Compare two strings with a maximum count of characters, ignoring the case of ASCII characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A–Z) are interpreted as values between 97 and 122 (ASCII a–z). This function cannot be used for language-specific sorting.

Since this function 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 of 0 and 127, inclusive.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second null-terminated ASCII string which is compared with the first one.
shortenedLen	the maximum number of characters to compare. This length can be greater or smaller than the lengths of the two strings.

Returns

0 if both substrings are equal, a value less than 0 if the first substring is less than the second substring, and a value greater than 0 if the first substring is greater than the second substring.

rtl_ustr_asciil_reverseCompare_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_asciil_reverseCompare_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const char *	second,
		sal_Int32	secondLen
	)

Compare two strings from back to front.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting.

Since this function 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 of 0 and 127, inclusive.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second ASCII string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen.
secondLen	the length of the second string.

Returns

0 if both strings are equal, a value less than 0 if the first string compares less than the second string, and a value greater than 0 if the first string compares greater than the second string.

rtl_ustr_asciil_reverseEquals_WithLength()

SAL_DLLPUBLIC sal_Bool rtl_ustr_asciil_reverseEquals_WithLength	(	const sal_Unicode *	first,
		const char *	second,
		sal_Int32	len
	)

Compare two strings from back to front for equality.

The comparison is based on the numeric value of each character in the strings and returns 'true' if, and only if, both strings are equal. This function cannot be used for language-specific sorting.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified len.
second	the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of both strings.

Returns

true if both strings are equal, false if they are not equal.

rtl_ustr_compare()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_compare	(	const sal_Unicode *	first,
		const sal_Unicode *	second
	)

Compare two strings.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting. Both strings must be null-terminated.

Parameters

first	the first null-terminated string to be compared.
second	the second null-terminated string which is compared with the first one.

Returns

0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string.

rtl_ustr_compare_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_compare_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const sal_Unicode *	second,
		sal_Int32	secondLen
	)

Compare two strings.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen.
secondLen	the length of the second string.

Returns

0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string.

rtl_ustr_compareIgnoreAsciiCase()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_compareIgnoreAsciiCase	(	const sal_Unicode *	first,
		const sal_Unicode *	second
	)

Compare two strings, ignoring the case of ASCII characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A–Z) are interpreted as values between 97 and 122 (ASCII a–z). This function cannot be used for language-specific sorting. Both strings must be null-terminated.

Parameters

first	the first null-terminated string to be compared.
second	the second null-terminated string which is compared with the first one.

Returns

0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string.

rtl_ustr_compareIgnoreAsciiCase_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_compareIgnoreAsciiCase_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const sal_Unicode *	second,
		sal_Int32	secondLen
	)

Compare two strings, ignoring the case of ASCII characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A–Z) are interpreted as values between 97 and 122 (ASCII a–z). This function cannot be used for language-specific sorting.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen.
secondLen	the length of the second string.

Returns

0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string.

rtl_ustr_getLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_getLength

(

const sal_Unicode *

str

)

Return the length of a string.

The length is equal to the number of 16-bit Unicode characters in the string, without the terminating NUL character.

Parameters

str	a null-terminated string.

Returns

the length of the sequence of characters represented by this string, excluding the terminating NUL character.

rtl_ustr_hashCode()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_hashCode

(

const sal_Unicode *

str

)

Return a hash code for a string.

It is not allowed to store the hash code persistently, because later versions could return other hash codes. The string must be null-terminated.

Parameters

str	a null-terminated string.

Returns

a hash code for the given string.

rtl_ustr_hashCode_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_hashCode_WithLength	(	const sal_Unicode *	str,
		sal_Int32	len
	)

Return a hash code for a string.

It is not allowed to store the hash code persistently, because later versions could return other hash codes.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string.

Returns

a hash code for the given string.

rtl_ustr_indexOfAscii_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_indexOfAscii_WithLength	(	sal_Unicode const *	str,
		sal_Int32	len,
		char const *	subStr,
		sal_Int32	subLen
	)

Search for the first occurrence of an ASCII substring within a string.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string; must be non-negative.
subStr	the substring to be searched for. Need not be null-terminated, but must be at least as long as the specified subLen. Must only contain characters in the ASCII range 0x00–7F.
subLen	the length of the substring; must be non-negative.

Returns

the index (starting at 0) of the first character of the first occurrence of the substring within the string, or -1 if the substring does not occur. If subLen is zero, -1 is returned.

Since

UDK 3.2.7

rtl_ustr_indexOfChar()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_indexOfChar	(	const sal_Unicode *	str,
		sal_Unicode	ch
	)

Search for the first occurrence of a character within a string.

The string must be null-terminated.

Parameters

str	a null-terminated string.
ch	the character to be searched for.

Returns

the index (starting at 0) of the first occurrence of the character in the string, or -1 if the character does not occur.

rtl_ustr_indexOfChar_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_indexOfChar_WithLength	(	const sal_Unicode *	str,
		sal_Int32	len,
		sal_Unicode	ch
	)

Search for the first occurrence of a character within a string.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string.
ch	the character to be searched for.

Returns

the index (starting at 0) of the first occurrence of the character in the string, or -1 if the character does not occur.

rtl_ustr_indexOfStr()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_indexOfStr	(	const sal_Unicode *	str,
		const sal_Unicode *	subStr
	)

Search for the first occurrence of a substring within a string.

If subStr is empty, or both str and subStr are empty, -1 is returned. Both strings must be null-terminated.

Parameters

str	a null-terminated string.
subStr	the null-terminated substring to be searched for.

Returns

the index (starting at 0) of the first character of the first occurrence of the substring within the string, or -1 if the substring does not occur.

rtl_ustr_indexOfStr_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_indexOfStr_WithLength	(	const sal_Unicode *	str,
		sal_Int32	len,
		const sal_Unicode *	subStr,
		sal_Int32	subLen
	)

Search for the first occurrence of a substring within a string.

If subStr is empty, or both str and subStr are empty, -1 is returned.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string.
subStr	the substring to be searched for. Need not be null-terminated, but must be at least as long as the specified subLen.
subLen	the length of the substring.

Returns

the index (starting at 0) of the first character of the first occurrence of the substring within the string, or -1 if the substring does not occur.

rtl_ustr_lastIndexOfAscii_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_lastIndexOfAscii_WithLength	(	sal_Unicode const *	str,
		sal_Int32	len,
		char const *	subStr,
		sal_Int32	subLen
	)

Search for the last occurrence of an ASCII substring within a string.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string; must be non-negative.
subStr	the substring to be searched for. Need not be null-terminated, but must be at least as long as the specified subLen. Must only contain characters in the ASCII range 0x00–7F.
subLen	the length of the substring; must be non-negative.

Returns

the index (starting at 0) of the first character of the last occurrence of the substring within the string, or -1 if the substring does not occur. If subLen is zero, -1 is returned.

Since

UDK 3.2.7

rtl_ustr_lastIndexOfChar()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_lastIndexOfChar	(	const sal_Unicode *	str,
		sal_Unicode	ch
	)

Search for the last occurrence of a character within a string.

The string must be null-terminated.

Parameters

str	a null-terminated string.
ch	the character to be searched for.

Returns

the index (starting at 0) of the last occurrence of the character in the string, or -1 if the character does not occur. The returned value is always smaller than the string length.

rtl_ustr_lastIndexOfChar_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_lastIndexOfChar_WithLength	(	const sal_Unicode *	str,
		sal_Int32	len,
		sal_Unicode	ch
	)

Search for the last occurrence of a character within a string.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string.
ch	the character to be searched for.

Returns

the index (starting at 0) of the last occurrence of the character in the string, or -1 if the character does not occur. The returned value is always smaller than the string length.

rtl_ustr_lastIndexOfStr()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_lastIndexOfStr	(	const sal_Unicode *	str,
		const sal_Unicode *	subStr
	)

Search for the last occurrence of a substring within a string.

If subStr is empty, or both str and subStr are empty, -1 is returned. Both strings must be null-terminated.

Parameters

str	a null-terminated string.
subStr	the null-terminated substring to be searched for.

Returns

the index (starting at 0) of the first character of the last occurrence of the substring within the string, or -1 if the substring does not occur.

rtl_ustr_lastIndexOfStr_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_lastIndexOfStr_WithLength	(	const sal_Unicode *	str,
		sal_Int32	len,
		const sal_Unicode *	subStr,
		sal_Int32	subLen
	)

Search for the last occurrence of a substring within a string.

If subStr is empty, or both str and subStr are empty, -1 is returned.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string.
subStr	the substring to be searched for. Need not be null-terminated, but must be at least as long as the specified subLen.
subLen	the length of the substring.

Returns

the index (starting at 0) of the first character of the first occurrence of the substring within the string, or -1 if the substring does not occur.

rtl_ustr_replaceChar()

SAL_DLLPUBLIC void rtl_ustr_replaceChar	(	sal_Unicode *	str,
		sal_Unicode	oldChar,
		sal_Unicode	newChar
	)

Replace all occurrences of a single character within a string.

If oldChar does not occur within str, then the string is not modified. The string must be null-terminated.

Parameters

str	a null-terminated string.
oldChar	the old character.
newChar	the new character.

rtl_ustr_replaceChar_WithLength()

SAL_DLLPUBLIC void rtl_ustr_replaceChar_WithLength	(	sal_Unicode *	str,
		sal_Int32	len,
		sal_Unicode	oldChar,
		sal_Unicode	newChar
	)

Replace all occurrences of a single character within a string.

If oldChar does not occur within str, then the string is not modified.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string.
oldChar	the old character.
newChar	the new character.

rtl_ustr_reverseCompare_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_reverseCompare_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const sal_Unicode *	second,
		sal_Int32	secondLen
	)

Compare two strings from back to front.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen.
secondLen	the length of the second string.

Returns

0 if both strings are equal, a value less than 0 if the first string compares less than the second string, and a value greater than 0 if the first string compares greater than the second string.

rtl_ustr_shortenedCompare_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_shortenedCompare_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const sal_Unicode *	second,
		sal_Int32	secondLen,
		sal_Int32	shortenedLen
	)

Compare two strings with a maximum count of characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen.
secondLen	the length of the second string.
shortenedLen	the maximum number of characters to compare. This length can be greater or smaller than the lengths of the two strings.

Returns

0 if both substrings are equal, a value less than 0 if the first substring is less than the second substring, and a value greater than 0 if the first substring is greater than the second substring.

rtl_ustr_shortenedCompareIgnoreAsciiCase_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_shortenedCompareIgnoreAsciiCase_WithLength	(	const sal_Unicode *	first,
		sal_Int32	firstLen,
		const sal_Unicode *	second,
		sal_Int32	secondLen,
		sal_Int32	shortenedLen
	)

Compare two strings with a maximum count of characters, ignoring the case of ASCII characters.

The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A–Z) are interpreted as values between 97 and 122 (ASCII a–z). This function cannot be used for language-specific sorting.

Parameters

first	the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen.
firstLen	the length of the first string.
second	the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen.
secondLen	the length of the second string.
shortenedLen	the maximum number of characters to compare. This length can be greater or smaller than the lengths of the two strings.

Returns

0 if both substrings are equal, a value less than 0 if the first substring is less than the second substring, and a value greater than 0 if the first substring is greater than the second substring.

rtl_ustr_toAsciiLowerCase()

SAL_DLLPUBLIC void rtl_ustr_toAsciiLowerCase

(

sal_Unicode *

str

)

Convert all ASCII uppercase letters to lowercase within a string.

The characters with values between 65 and 90 (ASCII A–Z) are replaced with values between 97 and 122 (ASCII a–z). The string must be null-terminated.

Parameters

str	a null-terminated string.

rtl_ustr_toAsciiLowerCase_WithLength()

SAL_DLLPUBLIC void rtl_ustr_toAsciiLowerCase_WithLength	(	sal_Unicode *	str,
		sal_Int32	len
	)

Convert all ASCII uppercase letters to lowercase within a string.

The characters with values between 65 and 90 (ASCII A–Z) are replaced with values between 97 and 122 (ASCII a–z).

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string.

rtl_ustr_toAsciiUpperCase()

SAL_DLLPUBLIC void rtl_ustr_toAsciiUpperCase

(

sal_Unicode *

str

)

Convert all ASCII lowercase letters to uppercase within a string.

The characters with values between 97 and 122 (ASCII a–z) are replaced with values between 65 and 90 (ASCII A–Z). The string must be null-terminated.

Parameters

str	a null-terminated string.

rtl_ustr_toAsciiUpperCase_WithLength()

SAL_DLLPUBLIC void rtl_ustr_toAsciiUpperCase_WithLength	(	sal_Unicode *	str,
		sal_Int32	len
	)

Convert all ASCII lowercase letters to uppercase within a string.

The characters with values between 97 and 122 (ASCII a–z) are replaced with values between 65 and 90 (ASCII A–Z).

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the string.

rtl_ustr_toBoolean()

SAL_DLLPUBLIC sal_Bool rtl_ustr_toBoolean

(

const sal_Unicode *

str

)

Interpret a string as a boolean.

This function cannot be used for language-specific conversion. The string must be null-terminated.

Parameters

str	a null-terminated string.

Returns

true if the string is "1" or "true" in any ASCII case, false otherwise.

rtl_ustr_toDouble()

SAL_DLLPUBLIC double rtl_ustr_toDouble

(

const sal_Unicode *

str

)

Interpret a string as a double.

This function cannot be used for language-specific conversion. The string must be null-terminated.

Parameters

str	a null-terminated string.

Returns

the float value represented by the string, or 0.0 if the string does not represent a double.

rtl_ustr_toFloat()

SAL_DLLPUBLIC float rtl_ustr_toFloat

(

const sal_Unicode *

str

)

Interpret a string as a float.

This function cannot be used for language-specific conversion. The string must be null-terminated.

Parameters

str	a null-terminated string.

Returns

the float value represented by the string, or 0.0 if the string does not represent a float.

rtl_ustr_toInt32()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_toInt32	(	const sal_Unicode *	str,
		sal_Int16	radix
	)

Interpret a string as an integer.

This function cannot be used for language-specific conversion. The string must be null-terminated.

Parameters

str	a null-terminated string.
radix	the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX (36), inclusive.

Returns

the integer value represented by the string, or 0 if the string does not represent an integer.

rtl_ustr_toInt64()

SAL_DLLPUBLIC sal_Int64 rtl_ustr_toInt64	(	const sal_Unicode *	str,
		sal_Int16	radix
	)

Interpret a string as a long integer.

This function cannot be used for language-specific conversion. The string must be null-terminated.

Parameters

str	a null-terminated string.
radix	the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX (36), inclusive.

Returns

the long integer value represented by the string, or 0 if the string does not represent a long integer.

rtl_ustr_toInt64_WithLength()

SAL_DLLPUBLIC sal_Int64 rtl_ustr_toInt64_WithLength	(	const sal_Unicode *	str,
		sal_Int16	radix,
		sal_Int32	nStrLength
	)

Interpret a string as a long integer.

This function cannot be used for language-specific conversion.

Parameters

str	a string.
radix	the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX (36), inclusive.
nStrLength	number of chars to process

Returns

the long integer value represented by the string, or 0 if the string does not represent a long integer.

rtl_ustr_toUInt32()

SAL_DLLPUBLIC sal_uInt32 rtl_ustr_toUInt32	(	const sal_Unicode *	str,
		sal_Int16	radix
	)

Interpret a string as an unsigned integer.

This function cannot be used for language-specific conversion. The string must be null-terminated.

Parameters

str	a null-terminated string.
radix	the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX (36), inclusive.

Returns

the unsigned integer value represented by the string, or 0 if the string does not represent an unsigned integer.

Since

LibreOffice 4.2

rtl_ustr_toUInt64()

SAL_DLLPUBLIC sal_uInt64 rtl_ustr_toUInt64	(	const sal_Unicode *	str,
		sal_Int16	radix
	)

Interpret a string as an unsigned long integer.

This function cannot be used for language-specific conversion. The string must be null-terminated.

Parameters

str	a null-terminated string.
radix	the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX (36), inclusive.

Returns

the unsigned long integer value represented by the string, or 0 if the string does not represent an unsigned long integer.

Since

LibreOffice 4.1

rtl_ustr_trim()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_trim

(

sal_Unicode *

str

)

Remove white space from both ends of a string.

All characters with values less than or equal to 32 (the space character) are considered to be white space. This function cannot be used for language-specific operations. The string must be null-terminated.

Parameters

str	a null-terminated string.

Returns

the new length of the string.

rtl_ustr_trim_WithLength()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_trim_WithLength	(	sal_Unicode *	str,
		sal_Int32	len
	)

Remove white space from both ends of the string.

All characters with values less than or equal to 32 (the space character) are considered to be white space. This function cannot be used for language-specific operations. The string must be null-terminated.

Parameters

str	a string. Need not be null-terminated, but must be at least as long as the specified len.
len	the original length of the string.

Returns

the new length of the string.

rtl_ustr_valueOfBoolean()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_valueOfBoolean	(	sal_Unicode *	str,
		sal_Bool	b
	)

Create the string representation of a boolean.

If b is true, the buffer is filled with the string "true" and 4 is returned. If b is false, the buffer is filled with the string "false" and 5 is returned. This function cannot be used for language-specific operations.

Parameters

str	a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_USTR_MAX_VALUEOFBOOLEAN define to create a buffer that is big enough.
b	a boolean value.

Returns

the length of the string.

rtl_ustr_valueOfChar()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_valueOfChar	(	sal_Unicode *	str,
		sal_Unicode	ch
	)

Create the string representation of a character.

Parameters

str	a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_USTR_MAX_VALUEOFCHAR define to create a buffer that is big enough.
ch	a character value.

Returns

the length of the string.

rtl_ustr_valueOfDouble()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_valueOfDouble	(	sal_Unicode *	str,
		double	d
	)

Create the string representation of a double.

This function cannot be used for language-specific conversion.

Parameters

str	a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_USTR_MAX_VALUEOFDOUBLE define to create a buffer that is big enough.
d	a double value.

Returns

the length of the string.

rtl_ustr_valueOfFloat()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_valueOfFloat	(	sal_Unicode *	str,
		float	f
	)

Create the string representation of a float.

This function cannot be used for language-specific conversion.

Parameters

str	a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_USTR_MAX_VALUEOFFLOAT define to create a buffer that is big enough.
f	a float value.

Returns

the length of the string.

rtl_ustr_valueOfInt32()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_valueOfInt32	(	sal_Unicode *	str,
		sal_Int32	i,
		sal_Int16	radix
	)

Create the string representation of an integer.

This function cannot be used for language-specific operations.

Parameters

str	a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_USTR_MAX_VALUEOFINT32 define to create a buffer that is big enough.
i	an integer value.
radix	the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX (36), inclusive.

Returns

the length of the string.

rtl_ustr_valueOfInt64()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_valueOfInt64	(	sal_Unicode *	str,
		sal_Int64	l,
		sal_Int16	radix
	)

Create the string representation of a long integer.

This function cannot be used for language-specific operations.

Parameters

str	a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_USTR_MAX_VALUEOFINT64 define to create a buffer that is big enough.
l	a long integer value.
radix	the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX (36), inclusive.

Returns

the length of the string.

rtl_ustr_valueOfUInt64()

SAL_DLLPUBLIC sal_Int32 rtl_ustr_valueOfUInt64	(	sal_Unicode *	str,
		sal_uInt64	l,
		sal_Int16	radix
	)

Create the string representation of an unsigned long integer.

This function cannot be used for language-specific operations.

Parameters

str	a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_USTR_MAX_VALUEOFUINT64 define to create a buffer that is big enough.
l	a long integer value.
radix	the radix. Must be between RTL_USTR_MIN_RADIX (2) and RTL_USTR_MAX_RADIX (36), inclusive.

Returns

the length of the string.

rtl_uString_acquire()

SAL_DLLPUBLIC void rtl_uString_acquire

(

rtl_uString *

str

)

Increment the reference count of a string.

Parameters

str

a string.

rtl_uString_alloc()

SAL_DLLPUBLIC rtl_uString* rtl_uString_alloc

(

sal_Int32

nLen

)

Allocate a new string containing space for a given number of characters.

The reference count of the new string will be 1. The length of the string will be nLen. This function does not handle out-of-memory conditions.

For failed allocation this method returns NULL.

The characters of the capacity are not cleared, and the length is set to nLen, unlike the similar method of rtl_uString_new_WithLength which zeros out the buffer, and sets the length to 0. So should be somewhat more efficient for allocating a new string.

call rtl_uString_release to release the string alternatively pass ownership to an OUString with rtl::OUString(newStr, SAL_NO_ACQUIRE);

Parameters

[in]

nLen

the number of characters. Must be >= 0.

Returns

pointer to the new string.

Since

LibreOffice 4.1

rtl_uString_assign()

SAL_DLLPUBLIC void rtl_uString_assign	(	rtl_uString **	str,
		rtl_uString *	rightValue
	)

Assign a new value to a string.

First releases any value str might currently hold, then acquires rightValue.

Parameters

str	pointer to the string. The pointed-to data must be null or a valid string.
rightValue	a valid string.

rtl_uString_ensureCapacity()

SAL_DLLPUBLIC void rtl_uString_ensureCapacity	(	rtl_uString **	str,
		sal_Int32	size
	)

Ensure a string has enough space for a given number of characters.

If the given string is large enough and has refcount of 1, it is not altered in any way. Otherwise it is replaced by a copy that has enough space for the given number of characters, data from the source string is copied to the beginning of it, the content of the remaining capacity undefined, the string has refcount of 1, and refcount of the original string is decreased.

Parameters

str	pointer to the string. The pointed-to data must be a valid string.
size	the number of characters

Since

LibreOffice 4.1

rtl_uString_getLength()

SAL_DLLPUBLIC sal_Int32 rtl_uString_getLength

(

const rtl_uString *

str

)

Return the length of a string.

The length is equal to the number of characters in the string.

Parameters

str	a valid string.

Returns

the length of the string.

rtl_uString_getStr()

SAL_DLLPUBLIC sal_Unicode* rtl_uString_getStr

(

rtl_uString *

str

)

Return a pointer to the underlying character array of a string.

Parameters

str	a valid string.

Returns

a pointer to the null-terminated character array.

rtl_uString_getToken()

SAL_DLLPUBLIC sal_Int32 rtl_uString_getToken	(	rtl_uString **	newStr,
		rtl_uString *	str,
		sal_Int32	token,
		sal_Unicode	cTok,
		sal_Int32	idx
	)

Create a new string by extracting a single token from another string.

Starting at index, the token's next token is searched for. If there is no such token, the result is an empty string. Otherwise, all characters from the start of that token and up to, but not including the next occurrence of cTok make up the resulting token. The return value is the position of the next token, or -1 if no more tokens follow.

Example code could look like rtl_uString * pToken = NULL; sal_Int32 nIndex = 0; do { ... nIndex = rtl_uString_getToken(&pToken, pStr, 0, ';', nIndex); ... } while (nIndex >= 0);

The new string does not necessarily have a reference count of 1, so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string. If either token or index is negative, an empty token is stored in newStr (and -1 is returned).
str	a valid string.
token	the number of the token to return, starting at index.
cTok	the character that separates the tokens.
idx	the position at which searching for the token starts. Must not be greater than the length of str.

Returns

the index of the next token, or -1 if no more tokens follow.

rtl_uString_intern()

SAL_DLLPUBLIC void rtl_uString_intern	(	rtl_uString **	newStr,
		rtl_uString *	str
	)

Return a canonical representation for a string.

A pool of strings, initially empty is maintained privately by the string class. On invocation, if present in the pool the original string will be returned. Otherwise this string, or a copy thereof will be added to the pool and returned.

Parameters

newStr

pointer to the new string. The pointed-to data must be null or a valid string.

If an out-of-memory condition occurs, newStr will point to a null pointer upon return.

Parameters

str	pointer to the string to be interned.

Since

UDK 3.2.7

rtl_uString_internConvert()

SAL_DLLPUBLIC void rtl_uString_internConvert	(	rtl_uString **	newStr,
		const char *	str,
		sal_Int32	len,
		rtl_TextEncoding	encoding,
		sal_uInt32	convertFlags,
		sal_uInt32 *	pInfo
	)

Return a canonical representation for a string.

A pool of strings, initially empty is maintained privately by the string class. On invocation, if present in the pool the original string will be returned. Otherwise this string, or a copy thereof will be added to the pool and returned.

Parameters

newStr

pointer to the new string. The pointed-to data must be null or a valid string.

If an out-of-memory condition occurs, newStr will point to a null pointer upon return.

Parameters

str	a byte character array. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the byte character array.
encoding	the text encoding to use for conversion.
convertFlags	flags which control the conversion. Either use OSTRING_TO_OUSTRING_CVTFLAGS, or see http://udk.openoffice.org/cpp/man/spec/textconversion.html for more details.
pInfo	pointer to return conversion status in, or NULL.

Since

UDK 3.2.7

rtl_uString_iterateCodePoints()

SAL_DLLPUBLIC sal_uInt32 rtl_uString_iterateCodePoints	(	rtl_uString const *	string,
		sal_Int32 *	indexUtf16,
		sal_Int32	incrementCodePoints
	)

Iterate through a string based on code points instead of UTF-16 code units.

See Chapter 3 of The Unicode Standard 5.0 (Addison–Wesley, 2006) for definitions of the various terms used in this description.

The given string is interpreted as a sequence of zero or more UTF-16 code units. For each index into this sequence (from zero to one less than the length of the sequence, inclusive), a code point represented starting at the given index is computed as follows:

• If the UTF-16 code unit addressed by the index constitutes a well-formed UTF-16 code unit sequence, the computed code point is the scalar value encoded by that UTF-16 code unit sequence.
• Otherwise, if the index is at least two UTF-16 code units away from the end of the sequence, and the sequence of two UTF-16 code units addressed by the index constitutes a well-formed UTF-16 code unit sequence, the computed code point is the scalar value encoded by that UTF-16 code unit sequence.
• Otherwise, the computed code point is the UTF-16 code unit addressed by the index. (This last case catches unmatched surrogates as well as indices pointing into the middle of surrogate pairs.)

Parameters

string	pointer to a valid string; must not be null.
indexUtf16	pointer to a UTF-16 based index into the given string; must not be null. On entry, the index must be in the range from zero to the length of the string (in UTF-16 code units), inclusive. Upon successful return, the index will be updated to address the UTF-16 code unit that is the given incrementCodePoints away from the initial index.
incrementCodePoints	the number of code points to move the given *indexUtf16. If non-negative, moving is done after determining the code point at the index. If negative, moving is done before determining the code point at the (then updated) index. The value must be such that the resulting UTF-16 based index is in the range from zero to the length of the string (in UTF-16 code units), inclusive.

Returns

the code point (an integer in the range from 0 to 0x10FFFF, inclusive) that is represented within the string starting at the index computed as follows: If incrementCodePoints is non-negative, the index is the initial value of indexUtf16; if incrementCodePoints is negative, the index is the updated value of *indexUtf16. In either case, the computed index must be in the range from zero to one less than the length of the string (in UTF-16 code units), inclusive.

Since

UDK 3.2.7

rtl_uString_new()

SAL_DLLPUBLIC void rtl_uString_new

(

rtl_uString **

newStr

)

Allocate a new string containing no characters.

Parameters

newStr

pointer to the new string. The pointed-to data must be null or a valid string.

rtl_uString_new_WithLength()

SAL_DLLPUBLIC void rtl_uString_new_WithLength	(	rtl_uString **	newStr,
		sal_Int32	nLen
	)

Allocate a new string containing space for a given number of characters.

If len is greater than zero, the reference count of the new string will be

1. The values of all characters are set to 0 and the length of the string is 0. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
nLen	the number of characters.

rtl_uString_newConcat()

SAL_DLLPUBLIC void rtl_uString_newConcat	(	rtl_uString **	newStr,
		rtl_uString *	left,
		rtl_uString *	right
	)

Create a new string that is the concatenation of two other strings.

The new string does not necessarily have a reference count of 1 (in cases where one of the two other strings is empty), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
left	a valid string.
right	a valid string.

rtl_uString_newConcatAsciiL()

SAL_DLLPUBLIC void rtl_uString_newConcatAsciiL	(	rtl_uString **	newString,
		rtl_uString *	left,
		char const *	right,
		sal_Int32	rightLength
	)

Create a new string that is the concatenation of two other strings.

The new string does not necessarily have a reference count of 1 (in cases where the ASCII string is empty), so it must not be modified without checking the reference count.

Parameters

newString	pointer to the new string. The pointed-to data must be null or a valid string.
left	a valid string.
right	must not be null and must point to memory of at least rightLength ASCII bytes
rightLength	the length of the right string; must be non-negative

Since

LibreOffice 5.1

rtl_uString_newConcatUtf16L()

SAL_DLLPUBLIC void rtl_uString_newConcatUtf16L	(	rtl_uString **	newString,
		rtl_uString *	left,
		sal_Unicode const *	right,
		sal_Int32	rightLength
	)

Create a new string that is the concatenation of two other strings.

The new string does not necessarily have a reference count of 1 (in cases where the UTF-16 string is empty), so it must not be modified without checking the reference count.

Parameters

newString	pointer to the new string. The pointed-to data must be null or a valid string.
left	a valid string.
right	must point to memory of at least rightLength UTF-16 code units; may be null if rigthLength is zero
rightLength	the length of the right string; must be non-negative

Since

LibreOffice 5.3

rtl_uString_newFromAscii()

SAL_DLLPUBLIC void rtl_uString_newFromAscii	(	rtl_uString **	newStr,
		const char *	value
	)

Allocate a new string that contains a copy of a character array.

If the length of value is greater than zero, the reference count of the new string will be 1. This function does not handle out-of-memory conditions.

Since this function 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 of 0 and 127, inclusive.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
value	a null-terminated ASCII character array.

rtl_uString_newFromCodePoints()

SAL_DLLPUBLIC void rtl_uString_newFromCodePoints	(	rtl_uString **	newString,
		sal_uInt32 const *	codePoints,
		sal_Int32	codePointCount
	)

Allocate a new string from an array of Unicode code points.

Parameters

newString	a non-null pointer to a (possibly null) rtl_uString pointer, which (if non-null) will have been passed to rtl_uString_release before the function returns. Upon return, points to the newly allocated string or to null if there was either an out-of-memory condition or the resulting number of UTF-16 code units would have been larger than SAL_MAX_INT32. The newly allocated string (if any) must ultimately be passed to rtl_uString_release.
codePoints	an array of at least codePointCount code points, which each must be in the range from 0 to 0x10FFFF, inclusive. May be null if codePointCount is zero.
codePointCount	the non-negative number of code points.

Since

UDK 3.2.7

rtl_uString_newFromLiteral()

SAL_DLLPUBLIC void rtl_uString_newFromLiteral	(	rtl_uString **	newStr,
		const char *	value,
		sal_Int32	len,
		sal_Int32	allocExtra
	)

rtl_uString_newFromStr()

SAL_DLLPUBLIC void rtl_uString_newFromStr	(	rtl_uString **	newStr,
		const sal_Unicode *	value
	)

Allocate a new string that contains a copy of a character array.

If the length of value is greater than zero, the reference count of the new string will be 1. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
value	a null-terminated character array.

rtl_uString_newFromStr_WithLength()

SAL_DLLPUBLIC void rtl_uString_newFromStr_WithLength	(	rtl_uString **	newStr,
		const sal_Unicode *	value,
		sal_Int32	len
	)

Allocate a new string that contains a copy of a character array.

If the length of value is greater than zero, the reference count of the new string will be 1. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
value	a character array. Need not be null-terminated, but must be at least as long as the specified len.
len	the length of the character array.

rtl_uString_newFromString()

SAL_DLLPUBLIC void rtl_uString_newFromString	(	rtl_uString **	newStr,
		const rtl_uString *	value
	)

Allocate a new string that contains a copy of another string.

If the length of value is greater than zero, the reference count of the new string will be 1. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
value	a valid string.

rtl_uString_newFromSubString()

SAL_DLLPUBLIC void rtl_uString_newFromSubString	(	rtl_uString **	newStr,
		const rtl_uString *	from,
		sal_Int32	beginIndex,
		sal_Int32	count
	)

Allocate a new string that is a substring of this string.

The substring begins at the specified beginIndex and contains count characters. Meaningless combinations such as negative beginIndex, or beginIndex + count greater than the length of the string have undefined behaviour.

Parameters

[out]	newStr	the specified substring.
[in]	from	the String to take the substring from.
[in]	beginIndex	the beginning index, inclusive.
[in]	count	the number of characters.

Since

LibreOffice 4.0

rtl_uString_newReplace()

SAL_DLLPUBLIC void rtl_uString_newReplace	(	rtl_uString **	newStr,
		rtl_uString *	str,
		sal_Unicode	oldChar,
		sal_Unicode	newChar
	)

Create a new string by replacing all occurrences of a single character within another string.

The new string results from replacing all occurrences of oldChar in str with newChar.

The new string does not necessarily have a reference count of 1 (in cases where oldChar does not occur in str), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
str	a valid string.
oldChar	the old character.
newChar	the new character.

rtl_uString_newReplaceAll()

SAL_DLLPUBLIC void rtl_uString_newReplaceAll	(	rtl_uString **	newStr,
		rtl_uString *	str,
		rtl_uString const *	from,
		rtl_uString const *	to
	)

Create a new string by replacing all occurrences of a given substring with another substring.

Replacing subsequent occurrences picks up only after a given replacement. That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null
	to	pointer to the replacing substring; must not be null

Since

LibreOffice 3.6

rtl_uString_newReplaceAllAsciiL()

SAL_DLLPUBLIC void rtl_uString_newReplaceAllAsciiL	(	rtl_uString **	newStr,
		rtl_uString *	str,
		char const *	from,
		sal_Int32	fromLength,
		rtl_uString const *	to
	)

Create a new string by replacing all occurrences of a given substring with another substring.

Replacing subsequent occurrences picks up only after a given replacement. That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength ASCII bytes
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the replacing substring; must not be null

Since

LibreOffice 3.6

rtl_uString_newReplaceAllAsciiLAsciiL()

SAL_DLLPUBLIC void rtl_uString_newReplaceAllAsciiLAsciiL	(	rtl_uString **	newStr,
		rtl_uString *	str,
		char const *	from,
		sal_Int32	fromLength,
		char const *	to,
		sal_Int32	toLength
	)

Create a new string by replacing all occurrences of a given substring with another substring.

Replacing subsequent occurrences picks up only after a given replacement. That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength ASCII bytes
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the substring to be replaced; must not be null and must point to memory of at least toLength ASCII bytes
	toLength	the length of the to substring; must be non-negative

Since

LibreOffice 3.6

rtl_uString_newReplaceAllAsciiLUtf16L()

SAL_DLLPUBLIC void rtl_uString_newReplaceAllAsciiLUtf16L	(	rtl_uString **	newStr,
		rtl_uString *	str,
		char const *	from,
		sal_Int32	fromLength,
		sal_Unicode const *	to,
		sal_Int32	toLength
	)

Create a new string by replacing all occurrences of a given substring with another substring.

Replacing subsequent occurrences picks up only after a given replacement. That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString; upon return, points to the newly allocated string or to null if there was either an out-of-memory condition or the resulting number of UTF-16 code units would have been larger than SAL_MAX_INT32
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength ASCII bytes
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the substring to be replaced; must point to memory of at least toLength UTF-16 code units; may be null if toLength is zero
	toLength	the length of the to substring; must be non-negative

Since

LibreOffice 3.6

rtl_uString_newReplaceAllFromIndex()

SAL_DLLPUBLIC void rtl_uString_newReplaceAllFromIndex	(	rtl_uString **	newStr,
		rtl_uString *	str,
		rtl_uString const *	from,
		rtl_uString const *	to,
		sal_Int32	fromIndex
	)

Create a new string by replacing all occurrences of a given substring with another substring.

Replacing subsequent occurrences picks up only after a given replacement. That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null
	to	pointer to the replacing substring; must not be null
	fromIndex	the position in the string where we will begin searching

Since

LibreOffice 4.0

rtl_uString_newReplaceAllToAsciiL()

SAL_DLLPUBLIC void rtl_uString_newReplaceAllToAsciiL	(	rtl_uString **	newStr,
		rtl_uString *	str,
		rtl_uString const *	from,
		char const *	to,
		sal_Int32	toLength
	)

Create a new string by replacing all occurrences of a given substring with another substring.

Replacing subsequent occurrences picks up only after a given replacement. That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null
	to	pointer to the replacing substring; must not be null and must point to memory of at least toLength ASCII bytes
	toLength	the length of the to substring; must be non-negative

Since

LibreOffice 5.1

rtl_uString_newReplaceAllUtf16LAsciiL()

SAL_DLLPUBLIC void rtl_uString_newReplaceAllUtf16LAsciiL	(	rtl_uString **	newStr,
		rtl_uString *	str,
		sal_Unicode const *	from,
		sal_Int32	fromLength,
		char const *	to,
		sal_Int32	toLength
	)

Create a new string by replacing all occurrences of a given substring with another substring.

Replacing subsequent occurrences picks up only after a given replacement. That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString; upon return, points to the newly allocated string or to null if there was either an out-of-memory condition or the resulting number of UTF-16 code units would have been larger than SAL_MAX_INT32
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength UTF-16 code units
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the substring to be replaced; must not be null and must point to memory of at least toLength ASCII bytes
	toLength	the length of the to substring; must be non-negative

Since

LibreOffice 3.6

rtl_uString_newReplaceAllUtf16LUtf16L()

SAL_DLLPUBLIC void rtl_uString_newReplaceAllUtf16LUtf16L	(	rtl_uString **	newStr,
		rtl_uString *	str,
		sal_Unicode const *	from,
		sal_Int32	fromLength,
		sal_Unicode const *	to,
		sal_Int32	toLength
	)

Create a new string by replacing all occurrences of a given substring with another substring.

Replacing subsequent occurrences picks up only after a given replacement. That is, replacing from "xa" to "xx" in "xaa" results in "xxa", not "xxx".

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString; upon return, points to the newly allocated string or to null if there was either an out-of-memory condition or the resulting number of UTF-16 code units would have been larger than SAL_MAX_INT32
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength UTF-16 code units
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the substring to be replaced; must not be null and must point to memory of at least toLength UTF-16 code units
	toLength	the length of the to substring; must be non-negative

Since

LibreOffice 3.6

rtl_uString_newReplaceFirst()

SAL_DLLPUBLIC void rtl_uString_newReplaceFirst	(	rtl_uString **	newStr,
		rtl_uString *	str,
		rtl_uString const *	from,
		rtl_uString const *	to,
		sal_Int32 *	index
	)

Create a new string by replacing the first occurrence of a given substring with another substring.

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null
	to	pointer to the replacing substring; must not be null
[in,out]	index	pointer to a start index, must not be null; upon entry to the function its value is the index into the original string at which to start searching for the from substring, the value must be non-negative and not greater than the original string's length; upon exit from the function its value is the index into the original string at which the replacement took place or -1 if no replacement took place

Since

LibreOffice 3.6

rtl_uString_newReplaceFirstAsciiL()

SAL_DLLPUBLIC void rtl_uString_newReplaceFirstAsciiL	(	rtl_uString **	newStr,
		rtl_uString *	str,
		char const *	from,
		sal_Int32	fromLength,
		rtl_uString const *	to,
		sal_Int32 *	index
	)

Create a new string by replacing the first occurrence of a given substring with another substring.

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength ASCII bytes
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the replacing substring; must not be null
[in,out]	index	pointer to a start index, must not be null; upon entry to the function its value is the index into the original string at which to start searching for the from substring, the value must be non-negative and not greater than the original string's length; upon exit from the function its value is the index into the original string at which the replacement took place or -1 if no replacement took place

Since

LibreOffice 3.6

rtl_uString_newReplaceFirstAsciiLAsciiL()

SAL_DLLPUBLIC void rtl_uString_newReplaceFirstAsciiLAsciiL	(	rtl_uString **	newStr,
		rtl_uString *	str,
		char const *	from,
		sal_Int32	fromLength,
		char const *	to,
		sal_Int32	toLength,
		sal_Int32 *	index
	)

Create a new string by replacing the first occurrence of a given substring with another substring.

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength ASCII bytes
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the substring to be replaced; must not be null and must point to memory of at least toLength ASCII bytes
	toLength	the length of the to substring; must be non-negative
[in,out]	index	pointer to a start index, must not be null; upon entry to the function its value is the index into the original string at which to start searching for the from substring, the value must be non-negative and not greater than the original string's length; upon exit from the function its value is the index into the original string at which the replacement took place or -1 if no replacement took place

Since

LibreOffice 3.6

rtl_uString_newReplaceFirstAsciiLUtf16L()

SAL_DLLPUBLIC void rtl_uString_newReplaceFirstAsciiLUtf16L	(	rtl_uString **	newStr,
		rtl_uString *	str,
		char const *	from,
		sal_Int32	fromLength,
		sal_Unicode const *	to,
		sal_Int32	toLength,
		sal_Int32 *	index
	)

Create a new string by replacing the first occurrence of a given substring with another substring.

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString; upon return, points to the newly allocated string or to null if there was either an out-of-memory condition or the resulting number of UTF-16 code units would have been larger than SAL_MAX_INT32
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength ASCII bytes
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the substring to be replaced; must not be null and must point to memory of at least toLength UTF-16 code units
	toLength	the length of the to substring; must be non-negative
[in,out]	index	pointer to a start index, must not be null; upon entry to the function its value is the index into the original string at which to start searching for the from substring, the value must be non-negative and not greater than the original string's length; upon exit from the function its value is the index into the original string at which the replacement took place (or would have taken place if newStr points to null upon return) or -1 if no replacement took place

Since

LibreOffice 5.3

rtl_uString_newReplaceFirstToAsciiL()

SAL_DLLPUBLIC void rtl_uString_newReplaceFirstToAsciiL	(	rtl_uString **	newStr,
		rtl_uString *	str,
		rtl_uString const *	from,
		char const *	to,
		sal_Int32	toLength,
		sal_Int32 *	index
	)

Create a new string by replacing the first occurrence of a given substring with another substring.

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null
	to	pointer to the replacing substring; must not be null and must point to memory of at least toLength ASCII bytes
	toLength	the length of the to substring; must be non-negative
[in,out]	index	pointer to a start index, must not be null; upon entry to the function its value is the index into the original string at which to start searching for the from substring, the value must be non-negative and not greater than the original string's length; upon exit from the function its value is the index into the original string at which the replacement took place or -1 if no replacement took place

Since

LibreOffice 5.1

rtl_uString_newReplaceFirstUtf16LAsciiL()

SAL_DLLPUBLIC void rtl_uString_newReplaceFirstUtf16LAsciiL	(	rtl_uString **	newStr,
		rtl_uString *	str,
		sal_Unicode const *	from,
		sal_Int32	fromLength,
		char const *	to,
		sal_Int32	toLength,
		sal_Int32 *	index
	)

Create a new string by replacing the first occurrence of a given substring with another substring.

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString; upon return, points to the newly allocated string or to null if there was either an out-of-memory condition or the resulting number of UTF-16 code units would have been larger than SAL_MAX_INT32
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must not be null and must point to memory of at least fromLength UTF-16 code units
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the substring to be replaced; must not be null and must point to memory of at least toLength ASCII bytes
	toLength	the length of the to substring; must be non-negative
[in,out]	index	pointer to a start index, must not be null; upon entry to the function its value is the index into the original string at which to start searching for the from substring, the value must be non-negative and not greater than the original string's length; upon exit from the function its value is the index into the original string at which the replacement took place (or would have taken place if newStr points to null upon return) or -1 if no replacement took place

Since

LibreOffice 5.3

rtl_uString_newReplaceFirstUtf16LUtf16L()

SAL_DLLPUBLIC void rtl_uString_newReplaceFirstUtf16LUtf16L	(	rtl_uString **	newStr,
		rtl_uString *	str,
		sal_Unicode const *	from,
		sal_Int32	fromLength,
		sal_Unicode const *	to,
		sal_Int32	toLength,
		sal_Int32 *	index
	)

Create a new string by replacing the first occurrence of a given substring with another substring.

Parameters

[in,out]	newStr	pointer to the new string; must not be null; must point to null or a valid rtl_uString; upon return, points to the newly allocated string or to null if there was either an out-of-memory condition or the resulting number of UTF-16 code units would have been larger than SAL_MAX_INT32
	str	pointer to the original string; must not be null
	from	pointer to the substring to be replaced; must point to memory of at least fromLength UTF-16 code units; may be null if toLength is zero
	fromLength	the length of the from substring; must be non-negative
	to	pointer to the substring to be replaced; must point to memory of at least toLength UTF-16 code units; may be null if toLength is zero
	toLength	the length of the to substring; must be non-negative
[in,out]	index	pointer to a start index, must not be null; upon entry to the function its value is the index into the original string at which to start searching for the from substring, the value must be non-negative and not greater than the original string's length; upon exit from the function its value is the index into the original string at which the replacement took place (or would have taken place if newStr points to null upon return) or -1 if no replacement took place

Since

LibreOffice 5.3

rtl_uString_newReplaceStrAt()

SAL_DLLPUBLIC void rtl_uString_newReplaceStrAt	(	rtl_uString **	newStr,
		rtl_uString *	str,
		sal_Int32	idx,
		sal_Int32	count,
		rtl_uString *	subStr
	)

Create a new string by replacing a substring of another string.

The new string results from replacing a number of characters (count), starting at the specified position (index) in the original string (str), with some new substring (subStr). If subStr is null, then only a number of characters is deleted.

The new string does not necessarily have a reference count of 1, so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
str	a valid string.
idx	the index into str at which to start replacement. Must be between 0 and the length of str, inclusive.
count	the number of characters to remove. Must not be negative, and the sum of index and count must not exceed the length of str.
subStr	either null or a valid string to be inserted.

rtl_uString_newToAsciiLowerCase()

SAL_DLLPUBLIC void rtl_uString_newToAsciiLowerCase	(	rtl_uString **	newStr,
		rtl_uString *	str
	)

Create a new string by converting all ASCII uppercase letters to lowercase within another string.

The new string results from replacing all characters with values between 65 and 90 (ASCII A–Z) by values between 97 and 122 (ASCII a–z).

This function cannot be used for language-specific conversion. The new string does not necessarily have a reference count of 1 (in cases where no characters need to be converted), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
str	a valid string.

rtl_uString_newToAsciiUpperCase()

SAL_DLLPUBLIC void rtl_uString_newToAsciiUpperCase	(	rtl_uString **	newStr,
		rtl_uString *	str
	)

Create a new string by converting all ASCII lowercase letters to uppercase within another string.

The new string results from replacing all characters with values between 97 and 122 (ASCII a–z) by values between 65 and 90 (ASCII A–Z).

This function cannot be used for language-specific conversion. The new string does not necessarily have a reference count of 1 (in cases where no characters need to be converted), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
str	a valid string.

rtl_uString_newTrim()

SAL_DLLPUBLIC void rtl_uString_newTrim	(	rtl_uString **	newStr,
		rtl_uString *	str
	)

Create a new string by removing white space from both ends of another string.

The new string results from removing all characters with values less than or equal to 32 (the space character), and also Unicode General Punctuation area Space and some Control characters, form both ends of str (see implIsWhitespace).

This function cannot be used for language-specific conversion. The new string does not necessarily have a reference count of 1 (in cases where no characters need to be removed), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions.

Parameters

newStr	pointer to the new string. The pointed-to data must be null or a valid string.
str	a valid string.

rtl_uString_release()

SAL_DLLPUBLIC void rtl_uString_release

(

rtl_uString *

str

)

Decrement the reference count of a string.

If the count goes to zero than the string data is deleted.

Parameters

str

a string.