Table of Contents

hfzReadHeader2

Description

Read a header from a HF2/HFZ file.

Function prototype

long hfzReadHeader2(const char* lpFileName, hfzHeader& fh);

Arguments

Name Type Description
lpFileName const char* The name of the file from which the header will be read.
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 hfzReadHeader2, fh may contain memory handles that must be freed by the caller. Once you are finished with the header, call hfzHeader_Reset to release this memory.