L3DT documentation
	Large 3D terrain generator

Nav | start » libhfz » functions » hfzreadheader

hfzReadHeader

hfzReadHeader

Description

Read the header from an open HF2/HFZ file.

Function prototype

long hfzReadHeader(hfzFile* fs, hfzHeader& fh);

Arguments

Name	Type	Description
fs	hfzFile*	A handle to an open hfzFile struct (see hfzOpen).
fh	hfzHeader&	The hfzHeader struct into which the file header data will be read.

Return value

LIBHFZ_STATUS_OK if the header was read successfully, and otherwise an error code. Use hfzGetErrorStr to retrieve the error description.

Comments

Remember to de-allocate the hfzHeader struct!

Afer calling hfzReadHeader, fh may contain handles memory that must be freed by the caller. Once you are finished with the header, call hfzHeader_Reset to release this memory.

libhfz/functions/hfzreadheader.txt · Last modified: 2017/08/31 06:10 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Share Alike 3.0 Unported