diff options
| author | Kurt Zenker <kz@openoffice.org> | 2005-01-18 12:40:58 +0000 |
|---|---|---|
| committer | Kurt Zenker <kz@openoffice.org> | 2005-01-18 12:40:58 +0000 |
| commit | 0acbc40aa39de93a8bf7afe78400baae42420aaa (patch) | |
| tree | e30a0803a4fd7a89cd9144bb8bbfb75b3fad582f /sal/inc/rtl/ustring.h | |
| parent | 3821bb967b9de624402631761ddd6150aabf5965 (diff) | |
INTEGRATION: CWS sb28 (1.13.50); FILE MERGED
2005/01/07 10:25:49 sb 1.13.50.2: #i32170# Imnproved documentation.
2005/01/05 14:09:13 sb 1.13.50.1: #i32170# Added documentation.
Diffstat (limited to 'sal/inc/rtl/ustring.h')
| -rw-r--r-- | sal/inc/rtl/ustring.h | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/sal/inc/rtl/ustring.h b/sal/inc/rtl/ustring.h index c8953a77da65..b023beb3c6fa 100644 --- a/sal/inc/rtl/ustring.h +++ b/sal/inc/rtl/ustring.h @@ -2,9 +2,9 @@ * * $RCSfile: ustring.h,v $ * - * $Revision: 1.13 $ + * $Revision: 1.14 $ * - * last change: $Author: rt $ $Date: 2004-09-20 08:42:44 $ + * last change: $Author: kz $ $Date: 2005-01-18 13:40:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -1376,7 +1376,19 @@ sal_Int32 SAL_CALL rtl_uString_getToken( rtl_uString ** newStr , rtl_uString * s /* ======================================================================= */ -/* constAsciiStr must be a "..." or char const aFoo[] = "..." */ +/** 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")). + + @param 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. +*/ #define RTL_CONSTASCII_USTRINGPARAM( constAsciiStr ) constAsciiStr, ((sal_Int32)(sizeof(constAsciiStr)-1)), RTL_TEXTENCODING_ASCII_US /* ======================================================================= */ |