fgi_bmphead() (Fastgraph/Image)

Win32 DirectX Fastgraph/Light

Prototype

int fgi_bmphead (char *filename, void *header, int handle);

Function fgi_bmphead (ByVal filename As String, header() As Any, ByVal handle As Long) As Long

function fgi_bmphead (filename : string; var header; handle : integer) : integer;

Description

The fgi_bmphead() function reads the header of a BMP file stored in an FGI library.

Parameters

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

header is the name of the buffer to receive the BMP file header. Its size must be at least 54 bytes.

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

-3 = The requested file is not a BMP file

Restrictions

none

See also

fgi_bmppal(), fg_bmpsize(), fgi_showbmp()