FLAIM: F_UnknownStream Class Reference

- Main Page
- Modules
- Classes
- Files

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# F_UnknownStream Class Reference

This is an abstract base class that allows an application to read "unknown" data from the RFL or to write "unknown" data to the RFL. More...

`#include <flaim.h>`

List of all members.

## Public Member Functions
virtual RCODE | read (FLMUINT uiLength, void *pvBuffer, FLMUINT *puiBytesRead)=0
| Read data for an "unknown" object from the RFL.
virtual RCODE | write (FLMUINT uiLength, void *pvBuffer)=0
| Write data to an "unknown" object in the RFL.
virtual RCODE | close (void)=0
| Close the stream.

## Detailed Description

This is an abstract base class that allows an application to read "unknown" data from the RFL or to write "unknown" data to the RFL.

The application must implement this class.

## Member Function Documentation

virtual RCODE F_UnknownStream::close | ( | void |  | ) | `[pure virtual]`

| Close the stream. If this is an input stream (read-only), the object should read to the end of the stream, discarding any remaining data.

virtual RCODE F_UnknownStream::read | ( | FLMUINT | uiLength,
|  | void * | pvBuffer,
|  | FLMUINT * | puiBytesRead
| ) | `[pure virtual]`

  | Read data for an "unknown" object from the RFL. Parameters:
  uiLength | Number of bytes to read.
  pvBuffer | Buffer to place read bytes into.
  puiBytesRead | Number of bytes actually read.

virtual RCODE F_UnknownStream::write | ( | FLMUINT | uiLength,
|  | void * | pvBuffer
| ) | `[pure virtual]`

  | Write data to an "unknown" object in the RFL. Parameters:
  uiLength | Number of bytes to write.
  pvBuffer | Data to be written out.