summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/io/XInputStream.idl
diff options
context:
space:
mode:
authorMichael Hönnig <mi@openoffice.org>2002-10-03 11:44:33 +0000
committerMichael Hönnig <mi@openoffice.org>2002-10-03 11:44:33 +0000
commit3ca7e230e0f4a6244bd4f094c31660e84f86caa7 (patch)
treeef1d86dc10aec150720c43759e504c610802cc7c /udkapi/com/sun/star/io/XInputStream.idl
parent2bd29645528ee70f4bd4bad65d485bcedc685621 (diff)
#94968# IDL reviews merged
Diffstat (limited to 'udkapi/com/sun/star/io/XInputStream.idl')
-rw-r--r--udkapi/com/sun/star/io/XInputStream.idl25
1 files changed, 20 insertions, 5 deletions
diff --git a/udkapi/com/sun/star/io/XInputStream.idl b/udkapi/com/sun/star/io/XInputStream.idl
index 29792f963..29ae4b160 100644
--- a/udkapi/com/sun/star/io/XInputStream.idl
+++ b/udkapi/com/sun/star/io/XInputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XInputStream.idl,v $
*
- * $Revision: 1.10 $
+ * $Revision: 1.11 $
*
- * last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
+ * last change: $Author: mi $ $Date: 2002-10-03 12:43:59 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -134,11 +134,20 @@ interface XInputStream: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XInputStream::readSomeBytes
- /** reads the available number of bytes at maximum
+ /** reads the available number of bytes, at maximum
<var>nMaxBytesToRead</var>.
- <p>This method blocks the thread until at least one byte is
- available. </p>
+ <p>This method is very similar to the readBytes method, except that
+ it has different blocking behaviour.
+ The method blocks as long as at least 1 byte is available or
+ EOF has been reached. EOF has only been reached, when the method
+ returns 0 and the corresponding byte sequence is empty.
+ Otherwise, after the call, aData contains the available,
+ but no more than nMaxBytesToRead, bytes.
+ @param aData contains the data read from the stream.
+ @param nMaxBytesToRead The maximum number of bytes to be read from this
+ stream during the call.
+ @see com::sun::star::io::XInputStream::readBytes
*/
long readSomeBytes( [out] sequence<byte> aData,
[in] long nMaxBytesToRead )
@@ -196,6 +205,12 @@ interface XInputStream: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.10.2.1 2002/06/05 16:38:40 jbu
+ documentation reviewed
+
+ Revision 1.10 2002/01/18 13:41:36 jbu
+ #96701# DataInputStream.idl DataOutputStream.idl MarkableInputStream.idl MarkableOutputStream.idl ObjectInputStream.idl ObjectOutputStream.idl Pipe.idl Pump.idl XDataInputStream.idl XDataOutputStream.idl XInputStream.idl XOutputStream.idl XPersistObject.idl
+
Revision 1.9 2001/11/16 14:45:32 mi
proofing by Richard Holt