====== hfzExtHeaderBlock_InitEx ======


===== Description =====

Initialise an set data in an extended header block (hfzExtHeaderBlock struct), which is contained in the extended header array within a hfzHeader struct.

===== Function prototype =====

<code>long hfzExtHeaderBlock_InitEx(hfzHeader& fh, long BlockID, const char* lpBlockType, const char* lpBlockName, unsigned long BlockDataLength, void* pBlockData);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| fh | hfzHeader& | The hfzHeader struct containing the hfzExtendedHeader struct to be set. |
| BlockID | long | The zero-based index of the hfzExtendedHeader struct to be set within the extended header array of the hfzHeader struct. |
| lpBlockType | const char* | A handle to a C-style string containing the block type ("bin", "txt" or "xml" are currently supported). Type length must not exceed 3 characters. |
| lpBlockName | const char* | A handle to a C-style string containing the block name. Please refer to [[l3dt:formats:specs:hf2:extheaderblocks|this page]] for a list of recognised block names. Name length must not exceed 15 characters. |
| BlockDataLength | unsigned long | The length of the data section of the extended header, in bytes. |
| pBlockData | void* | A handle to the data to be written in the extended header block. |

===== Return value =====

LIBHFZ_STATUS_OK if the operation completed successfully, and otherwise an error code. Use [[libhfz:functions:hfzGetErrorStr]] to retrieve the error description. 

===== Comments =====

None.