Class SCFileStream header file. More...

#import <fcntl.h>
#import <dirent.h>
#import <Foundation/Foundation.h>
#import <scl/SCStream.h>

Classes
class	SCFileStream
	File streams class. More...
Defines
#define	SCFileStreamClass @"SCFileStream"
	SCFileStream class name.
File stream supporting types
enum	_SCFileStreamOpenMode { SCFileStreamOpenReadOnly = 0, SCFileStreamOpenReadWrite = 1, SCFileStreamOpenWriteOnly = 2, SCFileStreamOpenWriteRead = 3, SCFileStreamOpenAppendWriteOnly = 4, SCFileStreamOpenAppendReadWrite = 5 }
enum	_SCFileStreamOffsetWhence { SCFileStreamOffsetStart = SEEK_SET, SCFileStreamOffsetCurrent = SEEK_CUR, SCFileStreamOffsetEnd = SEEK_END }
enum	_SCFileStreamStatus { SCFileStreamOK = 0, SCFileStreamIncorrectOpenModeError = 100, SCFileStreamEmptyPathError = 101, SCFileStreamEOFError = 102, SCFileStreamOffsetError = 103, SCFileStreamOffsetWhenceError = 104 }
typedef enum _SCFileStreamOpenMode	SCFileStreamOpenMode
	File stream open mode type.
typedef SCFileMode	SCFileStreamMode
	File opening mode type.
typedef enum _SCFileStreamOffsetWhence	SCFileStreamOffsetWhence
	File stream offset direction type.
typedef SCStreamStatus	SCFileStreamStatus
	File stream status type.

Detailed Description

Class SCFileStream header file.

Contains declaration of file stream class SCFileStream
File was introduced in version 1.1.3.

Typedef Documentation

File opening mode type.

Specifies the mode of opening file stream

File stream offset direction type.

Declares constants, which represents offset direction for seeking in file stream

File stream open mode type.

Declares the set of constants, which can be specified in class SCFileStream open methods

File stream status type.

Declares constants, which represents the status of the file stream

File stream offset direction enum type

Enumerator:

SCFileStreamOffsetStart	Offset is set from file stream start.
SCFileStreamOffsetCurrent	Offset is set from current position.
SCFileStreamOffsetEnd	Offset is set from file stream end.

File stream open mode enum type

Enumerator:

SCFileStreamOpenReadOnly	Open file for reading. The stream is positioned at the beginning of the file.
SCFileStreamOpenReadWrite	Open file for reading and writing. The stream is positioned at the beginning of the file.
SCFileStreamOpenWriteOnly	Truncate file to zero length or create text file for writing. The stream is positioned at the beginning of the file.
SCFileStreamOpenWriteRead	Open for reading and writing. The file is created if it does not exist, otherwise it is truncated. The stream is positioned at the beginning of the file.
SCFileStreamOpenAppendWriteOnly	Open for writing. The file is created if it does not exist. The stream is positioned at the end of the file. Subsequent writes to the file will always end up at the then current end of file, irrespective of any intervening seek operations.
SCFileStreamOpenAppendReadWrite	Open for reading and writing. The file is created if it does not exist. The stream is positioned at the end of the file. Subsequent writes to the file will always end up at the then current end of file, irrespective of any intervening seek operations.

File stream status enum type

Enumerator:

SCFileStreamOK	No errors.
SCFileStreamIncorrectOpenModeError	Incorrect open mode error.
SCFileStreamEmptyPathError	File stream empty path error.
SCFileStreamEOFError	End of stream error.
SCFileStreamOffsetError	Stream offset error.
SCFileStreamOffsetWhenceError	Incorrect offset whence error.