SCFileStream.h File Reference

Class SCFileStream header file. More...

#import <scl/SCStream.h>

Go to the source code of this file.

Classes
class	SCFileStream
	File stream class. More...

Class Constants
#define	SCFileStreamClass   @"SCFileStream"
	Class SCFileStream name.

File Stream Support Types
enum	_SCFileStreamStatus {   SCFileStreamOK = 0, SCFileStreamIncorrectOpenModeError = -20033, SCFileStreamEmptyPathError = -20034, SCFileStreamEOFError = -20035,   SCFileStreamOffsetError = -20036, SCFileStreamOffsetWhenceError = -20037 }
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 }
typedef SCStreamStatus	SCFileStreamStatus
	File stream status type. More...
typedef enum _SCFileStreamOpenMode	SCFileStreamOpenMode
	File stream opening modes type. More...
typedef enum _SCFileStreamOffsetWhence	SCFileStreamOffsetWhence
	Stream offset whence type. More...

Detailed Description

Class SCFileStream header file.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.1.3

Contains the declaration of the file stream class SCFileStream.

Typedef Documentation

SCFileStreamOffsetWhence

Stream offset whence type.

Contains the contstants, which are declared the whence of the file stream offset.

SCFileStreamOpenMode

File stream opening modes type.

Declares constants, which are represent various file stream opening modes.

SCFileStreamStatus

File stream status type.

Declares constants, which are represent various file stream statuses

Enumeration Type Documentation

enum _SCFileStreamOffsetWhence

Stream offset whences enum type.

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

enum _SCFileStreamOpenMode

File stream opening modes 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 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 exists. 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.

enum _SCFileStreamStatus

File stream status enum type.

Enumerator
SCFileStreamOK	No errors
SCFileStreamIncorrectOpenModeError	Incorrect file stream opening mode
SCFileStreamEmptyPathError	Empty path to the file stream
SCFileStreamEOFError	End of stream detected
SCFileStreamOffsetError	Incorrect stream offset
SCFileStreamOffsetWhenceError	Incorrect stream offset whence