summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCaolán McNamara <caolanm@redhat.com>2011-12-15 11:55:47 +0000
committerCaolán McNamara <caolanm@redhat.com>2011-12-15 12:22:50 +0000
commit5c1490fa4b69cfc05572dc84c5a9316d5e07a57c (patch)
tree7bcd8d96d32629de3e6e6b67de4b596881b2db13
parent473ed3e849c58aec154e6d60bb5ae6cdb4f13b25 (diff)
add some comments
-rw-r--r--tools/inc/tools/stream.hxx8
1 files changed, 6 insertions, 2 deletions
diff --git a/tools/inc/tools/stream.hxx b/tools/inc/tools/stream.hxx
index 5dca30fdb264..15547763d33a 100644
--- a/tools/inc/tools/stream.hxx
+++ b/tools/inc/tools/stream.hxx
@@ -553,11 +553,15 @@ TOOLS_DLLPUBLIC rtl::OString read_uInt8s_AsOString(SvStream& rStr, sal_Size nLen
//rtl::OUString's length is number of units successfully read
TOOLS_DLLPUBLIC rtl::OUString read_LEuInt16s_AsOUString(SvStream& rStr, sal_Size nLen);
-//Attempt to read 8bit units to an OString until a zero terminator is encountered
+//Attempt to read 8bit units to an OString until a zero terminator is
+//encountered, returned rtl::OString's length is number of units *definitely*
+//successfully read, check SvStream::good() to see if null terminator was
+//sucessfully read
TOOLS_DLLPUBLIC rtl::OString read_zeroTerminated_uInt8s_AsOString(SvStream& rStr);
//Attempt to read 8bit units assuming source encoding eEnc to an OUString until
-//a zero terminator is encountered
+//a zero terminator is encountered. Check SvStream::good() to see if null
+//terminator was sucessfully read
TOOLS_DLLPUBLIC rtl::OUString read_zeroTerminated_uInt8s_AsOUString(SvStream& rStr, rtl_TextEncoding eEnc);
// --------------