summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Adam <obnox@samba.org>2010-10-31 08:02:17 +0100
committerMichael Adam <obnox@samba.org>2010-11-03 22:45:20 +0000
commitc18b67235c71ab012d1d74d8fdc1e5f38d713362 (patch)
tree8fb657970c3c31078f90adeaed52af1085e5abd0
parent9b86df8ce86411e774515fdcb3f5c9826ecb91d2 (diff)
downloadsamba-c18b67235c71ab012d1d74d8fdc1e5f38d713362.tar.gz
samba-c18b67235c71ab012d1d74d8fdc1e5f38d713362.tar.bz2
samba-c18b67235c71ab012d1d74d8fdc1e5f38d713362.zip
lib/util/charset/util_unistr: clarify the comment header for strlen_m().
-rw-r--r--lib/util/charset/util_unistr.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/lib/util/charset/util_unistr.c b/lib/util/charset/util_unistr.c
index 74b453bf46..410547400d 100644
--- a/lib/util/charset/util_unistr.c
+++ b/lib/util/charset/util_unistr.c
@@ -324,12 +324,13 @@ _PUBLIC_ size_t strlen_m_ext_term(const char *s, const charset_t src_charset,
return strlen_m_ext(s, src_charset, dst_charset) + 1;
}
-
/**
- Count the number of UCS2 characters in a string. Normally this will
- be the same as the number of bytes in a string for single byte strings,
- but will be different for multibyte.
-**/
+ * Calculate the number of 16-bit units that would be needed to convert
+ * the input string which is expected to be in CH_UNIX encoding to UTF16.
+ *
+ * This will be the same as the number of bytes in a string for single
+ * byte strings, but will be different for multibyte.
+ */
_PUBLIC_ size_t strlen_m(const char *s)
{
return strlen_m_ext(s, CH_UNIX, CH_UTF16LE);