====== zformat_SetFlags ======

===== Description =====

Set the file format support flags for a file format handler variable (''VarID_format'').

===== Files =====

^ Declaration | ''Zeolite.h'' |
^ Implementation | ''Zeolite.cpp'' |

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

<code="C++">
bool zformat_SetFlags(ZFORMAT hFormat, unsigned long Flags);
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //hFormat// |  ''ZFORMAT''  | A [[zeolite:types:ZFORMAT]] handle to the file format handler variable, which must be initialised as type VarID_format. |
|  //Flags//  |  ''unsigned long''  | An unsigned long integer representing a bitfield containing the file format support flags. See comments for supported values. |

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

False if an error occurred, and true otherwise.

===== Comments =====

==== Supported flag values ====

The //Flags// argument may be a binary 'or' combination of zero or more of the following values defined in ''Zeolite_defines.h'':

^ Symbol  ^  Hex value  ^ Description ^
| ''ZFORMAT_FLAG_NATIVE''  |  0x01  | The file format is supported as a nominally lossless load/save format.  |
| ''ZFORMAT_FLAG_MOSAIC''  |  0x02  | The file format supports mosaic tiling. Either ''ZFORMAT_FLAG_LOADTILE'' or ''ZFORMAT_FLAG_SAVETILE'' must also be set. |
| ''ZFORMAT_FLAG_LOAD''  |  0x04  | The file format supports the load operation. The implementation plugin must export the ''zeoLoadMapFile'' function. |
| ''ZFORMAT_FLAG_SAVE''  |  0x08  | The file format supports the save operation. The implementation plugin must export the ''zeoSaveMapFile'' function. |
| ''ZFORMAT_FLAG_LOADTILE''  |  0x10   | The file format supports the mosaic tile load operation. The implementation plugin must export the ''zeoLoadTileFile'' function. |
| ''ZFORMAT_FLAG_SAVETILE''  |  0x20  | The file format supports the mosaic tile save operation. The implementation plugin must export the ''zeoSaveTileFile'' function. |