FMIceLinkFileStream Class Reference

Inherits from	NSObject
Conforms to	FMIceLinkIFileStream
Declared in	FMIceLinkFileStream.h FMIceLinkFileStream.m

`– path`

Gets the path.

- (NSString *)path

Discussion

Gets the path.

Declared In

FMIceLinkIFileStream.h

`– length`

Gets the file stream length (must be opened first).

- (long long)length

Discussion

Gets the file stream length (must be opened first).

Declared In

FMIceLinkIFileStream.h

`– position`

Gets the position in the file stream.

- (long long)position

Discussion

Gets the position in the file stream.

Declared In

FMIceLinkIFileStream.h

`– setPosition:`

Sets the [position](../Protocols/FMIceLinkIFileStream.html#//api/name/position) in the file stream.

- (void)setPosition:(long long)position

Discussion

Sets the [position](../Protocols/FMIceLinkIFileStream.html#//api/name/position) in the file stream.

Declared In

FMIceLinkIFileStream.h

`– exists`

Returns a boolean value indicating whether the file exists.

- (bool)exists

Discussion

Returns a boolean value indicating whether the file exists.

Declared In

FMIceLinkIFileStream.h

`– openWithAccess:`

Opens the file stream.

- (void)openWithAccess:(FMIceLinkFileStreamAccess)access

Parameters

`access`	The access requirement.

Discussion

Opens the file stream.

Declared In

FMIceLinkIFileStream.h

`– close`

Closes the file stream.

- (void)close

Discussion

Closes the file stream.

Declared In

FMIceLinkIFileStream.h

`– flush`

Flushes the file stream.

- (bool)flush

Discussion

Flushes the file stream.

Declared In

FMIceLinkIFileStream.h

`– writeWithData:index:length:`

Writes data to the file stream.

- (bool)writeWithData:(NSMutableData *)data index:(int)index length:(int)length

Parameters

`data`	The data to write.
`index`	The index at which to start reading.
`length`	The number of bytes to write.

Return Value

true if the data was written; otherwise, false.

Discussion

Writes data to the file stream.

Declared In

FMIceLinkIFileStream.h

`– writeToWithLocation:data:index:length:`

Writes data to the file stream.

- (bool)writeToWithLocation:(int)location data:(NSMutableData *)data index:(int)index length:(int)length

Parameters

`location`	The location to write to.
`data`	The data to write to the file.
`index`	The index at which to start reading.
`length`	The number of bytes to write.

Return Value

true if the data was written; otherwise, false.

Discussion

Writes data to the file stream.

Declared In

FMIceLinkIFileStream.h

`– readWithData:index:length:`

Reads data from the file stream.

- (int)readWithData:(NSMutableData *)data index:(int)index length:(int)length

Parameters

`data`	The buffer to fill with data from the file.
`index`	The index at which to start writing.
`length`	The maximum number of bytes to read.

Return Value

The number of bytes read from the file.

Discussion

Reads data from the file stream.

Declared In

FMIceLinkIFileStream.h