DelegatedFile

Scaleform::FileConstants
    Scaleform::File
        Scaleform::DelegatedFile

Declaration

class DelegatedFile : public File;

Description

DelegatedFile is a file implementation that delegates all calls to the specified File pointer. This class can be used to create file wrappers, such as BufferedFile, that provide extra functionality.

DelegatedFile AddRef() is the file that it delegates to; this file pointer can only be specified on constructor.

Methods

Method	Description
BytesAvailable	Returns the number of bytes available to read from a stream without blocking.
GetFilePath	Returns a file name path relative to the 'reference' directory.
IsValid	Determines if the delegated file is usable (open).
LGetLength	Overridden method. Returns the length of the file.
Close	Closes the file.
Flush	Causes any implementation's buffered data to be delivered to destination.
ChangeSize	Resizes the delegated file.
DelegatedFile	DelegatedFile constructor.
CopyFromStream	Appends other file data from a stream.
GetErrorCode	File Information -return errno-based error code. Useful if any other function failed.
GetLength	Overrridden method. Returns the length of the file.
LSeek	Overridden method. Sets file position indicator in the delegated file.
IsWritable	Determines if the delegated file is writeable.
Read	Blocking read, will read in the given number of bytes or less from the stream.
Seek	Overridden method. Seeks to a position in the delegated file.
LTell	Overridden method, returns the current position in the delegated file.
SkipBytes	Skips (ignores) a given number of bytes in the delegated file.
Write	Blocking write, writes in the given number of bytes or less to the stream.
Tell	Overridden method, returns the current position in the delegated file.

File

SF_File.h