From 5c1490fa4b69cfc05572dc84c5a9316d5e07a57c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Caol=C3=A1n=20McNamara?= Date: Thu, 15 Dec 2011 11:55:47 +0000 Subject: [PATCH] add some comments --- tools/inc/tools/stream.hxx | 8 ++++++-- 1 file 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); // --------------