formZ SDK | 5.0 API Reference | System | IO Streams

fz_iost_file_open_read

Description

Opens a file as an IO stream for reading. The file name should be pathless. It will thus reside in the current working directory (set by fzrt_file_vspec_set_crnt). This will avoid any platform dependencies on path strings.

Plugin Prototype

fzrt_error_td fz_iost_file_open_read(

fzrt_floc_ptr

floc,

fzrt_int

flags,

fz_iost_ptr *

iost_ptr,

fzrt_unsigned_int *

version,

char *

endian )

Parameters

floc [Input]

The file location for the file.

flags [Input]

IOST flags. Must be FZ_IOST_FLAGS_NONE.

iost_ptr [Result]

The created IO stream.

version [Result, Optional]

The version read from the stream's header.

endian [Result, Optional]

The endianness of the data to in the stream.

Returns

FZRT_NOERR on success. Otherwise, an error code.

Availability

5.0.0.0

See Also

fz_iost_file_open_write, fz_iost_file_close

Function Set

fz_iost_fset


Defined in

fz_iost_api.h