====== hfzSetLocalByteOrder ======



===== Description =====

Set the local byte ordering in LibHFZ. If this function is not called, the assumed byte order is little-endian (Intel / Windows).

<note>
All HF2/HFZ files are stored in little-endian format. This function should be called on big-endian systems (e.g. Unix) before using any other LibHFZ function.
</note>

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

<code>TYPE hfzSetLocalByteOrder(long ByteOrder);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| ByteOrder | long | The local byte order. See comments for allowed values. |

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

LIBHFZ_ERROR_INVALID_PARAM if the byte order is not supported, and STATUS_OK LIBHFZ_STATUS_OK otherwise.

===== Comments =====

==== Supported byte orders ====

The following tokens are accepted by hfzSetLocalByteOrder:
  * LIBHFZ_BYTEORDER_LITTLEENDIAN
  * LIBHFZ_BYTEORDER_INTEL
  * LIBHFZ_BYTEORDER_WINDOWS
  * LIBHFZ_BYTEORDER_BIGENDIAN
  * LIBHFZ_BYTEORDER_MOTOROLA
  * LIBHFZ_BYTEORDER_UNIX
The first three values are equivalent to one another, as are the last three values.