xflminterface IF_IStream : public XF_RefCount

This class represents an input stream object. It extends XF_RefCount.  An IF_IStream object may be obtained by invoking various methods on the IF_DbSystem object: openBufferIStream, openFileIStream, openMultiFileIStream, etc.  An application may also write its own implementation of the IF_IStream interface if it wants to pass data into various methods that take an IF_IStream object as a parameter.

Method Summary
RCODE  

 read - A method to read a number of bytes from the input stream.
void  close - A method to close the input stream.

 

Method Detail

read

    RCODE read(

        void *                pvBuffer,
        FLMUINT        uiBytesToRead,
        FLMUINT *     puiBytesRead);

This is a method to read a number of bytes from the input stream.

    Parameters In:

FLMUINT uiBytesToRead The number of bytes requested.

    Parameters Out:

void * pvBuffer The buffer to store the data read.
FLMUINT * puiBytesRead The number of bytes that were actually read from the stream.

[Back to Top]

close

    void close( void);

This is a method to close the input stream.

    Parameters In: none.

    Parameters Out: none.

    See Also:

[Back to Top]