L3DT documentation
Large 3D terrain generator

hfzHeader_DecodeExtHeaderBuf

Description

Decode a byte array from the extended header field of a HF2/HFZ file into the array of hfzExtHeaderBlock structs in a hfzHeader struct (see pExtHeaderBlocks member).

Function prototype

long hfzHeader_DecodeExtHeaderBuf(hfzHeader &fh, char* pBuf);

Arguments

Name Type Comment
fh hfzHeader& The hfzHeader struct corresponding to the extended header buffer, the pExtHeaderBlocks array of which will be initialised and filled with the extended header blocks.
pBuf char* The raw byte array of the extended header from the HF2/HFZ file.

Return value

The number of blocks decoded (if 0 or greater), or otherwise an error code. Use hfzGetErrorStr to retrieve the error description.

Comments

This function is used internally within LibHFZ to decode the extended headers in HFZ/HF2 files. Developers would not normally need to use this function.

 
libhfz/functions/hfzheader_decodeextheaderbuf.txt · Last modified: 2017/08/31 04:51 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki