fgi_read() (Fastgraph/Image)

Win32 DirectX Fastgraph/Light

Prototype

int fgi_read (char *filename, void *buffer, int handle);

Function fgi_read (ByVal filename As String, buffer() As Any, ByVal handle As Long) As Long

function fgi_read (filename : string; var buffer; handle : integer) : integer;

Description

The fgi_read() function reads the contents of a file stored in an FGI library into an array or allocated memory block.

Parameters

filename is the name of the file to retrieve. It may only include a file name and extension (such as PICTURE.PCX) and must be terminated by a null character (that is, a zero byte).

buffer is the name of the array or memory block that will receive the file contents.

handle is the file handle for the FGI library containing filename.

Return value

0 = Success

-1 = Error reading the FGI library

-2 = The requested file is not in the FGI library

Restrictions

none

See also

fgi_readnext()

Examples

FGIW4, FGIW5