L3DT documentation
	Large 3D terrain generator

Nav | start » libhfz » functions » hfzheader_encodeextheaderbuf

hfzHeader_EncodeExtHeaderBuf

hfzHeader_EncodeExtHeaderBuf

Description

Encode the array of hfzExtHeaderBlock structs in a hfzHeader struct (see pExtHeaderBlocks member) into a byte array.

Function prototype

long hfzHeader_EncodeExtHeaderBuf(hfzHeader &fh, char** ppBuf);

Arguments

Name	Type	Comment
fh	hfzHeader&	The hfzHeader struct containing the initialised array of hfzExtHeaderBlock structs (see pExtHeaderBlocks member) that shall be compiled into a byte array.
pBuf	char*	A handle to an uninitialised raw byte pointer, which shall be initialised and filled with the extended header by array by this function.

Return value

The number of bytes taken by the compiled extended header (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 encode the extended headers in HFZ/HF2 files. Developers would not normally need to use this function.

libhfz/functions/hfzheader_encodeextheaderbuf.txt · Last modified: 2017/08/31 04:21 (external edit)

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