====== format_GetOptionList ======

===== Description =====

Retrieve the list of options for a file format, as typically set by the [[zeolite:functions:format_SetOptionValue|CExtAPI::format_SetOptionValue]] function. 

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

<code>ZLIST CExtAPI::format_GetOptionList(ZFORMAT hFormat);</code>


===== Arguments =====

^ Name ^ Type ^ Comment ^
| hFormat | [[zeolite:types:ZFORMAT]] | A ZFORMAT handle, the options list of which is to be retrieved. |

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

NULL if an error occurred, and a valid [[zeolite:types:ZLIST]] handle otherwise.

===== Comments =====

This function can be used to retrieve format options that cannot be accessed by the [[zeolite:functions:format_GetOptionValue|CExtAPI::format_GetOptionValue]] function, namely classes such as ProgBox, map, ComboSelector, etc. These members can then be accessed using the CExtAPI::list_ functions.

===== Example =====

<code>
// get the options list
ZLIST hOptions = theAPI.format_GetOptionList(hFormat);
if(!hOptions) {
  theAPI.ReportError("CL3DTio_HTFApp::SaveMapFile error:\r\n - cannot retrieve options list");
  return false;
}

...
	
if(hComboSel = theAPI.list_GetItemA(hOptions, "FlipAxes")) { // access list member by name
  CString SelStr;
  SelStr.SetString(theAPI.combosel_GetCurSel(hComboSel));
  if(SelStr.CompareNoCase("None")==0)	
    PackMode = HTF_INVERT_NONE;
  else

...
</code>