http://bundysoft.com/docs/ 2026-05-13T16:52:07+00:00 http://bundysoft.com/docs/ http://bundysoft.com/docs/lib/images/favicon.ico text/html 2017-08-31T05:02:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:buffer_free&rev=1504155762&do=diff Description Release the memory allocated in a buffer (see buffer_Init). Function prototype bool CExtAPI::buffer_Free(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable, the memory of which is to be de-allocated. Return value False if the buffer is uninitialised or an error occurred, and true otherwise. text/html 2017-08-31T06:00:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:buffer_getptr&rev=1504159228&do=diff Description Get the raw pointer of a memory buffer. Function prototype void* CExtAPI::buffer_GetPtr(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable from which the memory buffer pointer is to be retrieved. Return value Null if an error occurred or the buffer is uninitialised, and a valid non-null pointer otherwise. text/html 2017-08-31T04:15:37+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:buffer_getvalue&rev=1504152937&do=diff Description Retrieve the value of an item in a buffer. Function prototype bool CExtAPI::buffer_GetValue(ZVAR hBuf, long index, void* pValue); Arguments Name Type Comment hBuf ZVAR A ZVAR handle to a buffer variable. index long The zero-based index of the item to be retrieved. pValue void* A pointer to the memory into which the value will be copied. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:31:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:buffer_init&rev=1504161073&do=diff Description Allocate memory in a buffer variable. Function prototype bool CExtAPI::buffer_Init(ZVAR hBuf, long nItems, long ItemSize); Arguments Name Type Comment hBuf ZVAR A handle to the buffer variable to be initialised. nItems long The number of items for which memory is to be allocated. ItemSize long The size, in bytes, of the items in the buffer. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:58:59+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:buffer_itemsize&rev=1504162739&do=diff Description Retrieve the size, in bytes, of each item in a buffer (as set in buffer_Init). To retrieve the combined size of all items in a buffer, use buffer_MemSize. Function prototype int CExtAPI::buffer_ItemSize(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable, the item size of which is to be retrieved. Return value Zero if the buffer is not initialised or an error occurred, and non-zero otherwise. text/html 2011-04-21T13:53:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:buffer_memsize&rev=1303394011&do=diff Description Determine the total number of bytes allocated in the buffer. Function prototype long CExtAPI::buffer_MemSize(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable, from which the total memory allocation (in bytes) is to be determined. Return value A positive integer representing the total number of bytes allocated in the buffer, or zero if the buffer is uninitialised or an error occurred. text/html 2017-08-31T07:10:44+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:buffer_nitems&rev=1504163444&do=diff Description Retrieve the number of items allocated in a buffer, as set by buffer_Init. Function prototype long CExtAPI::buffer_nItems(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable, from which the number of items contained are to be determined. Return value Zero if the buffer is uninitialised or an error occurred, and otherwise a positive integer representing the number of items allocated in the buffer. text/html 2017-08-31T05:42:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:buffer_setvalue&rev=1504158169&do=diff Description Set the value of an item in a buffer. Function prototype bool CExtAPI::buffer_SetValue(ZVAR hBuf, long index, void* pValue); Arguments Name Type Comment hBuf ZVAR A ZVAR handle to a buffer variable. index long The zero-based index of the item to be set. pValue void* A pointer to the value to be copied. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:32:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:calc_am_getidfromcolour&rev=1504153956&do=diff API Description Get the 16-bit ID of a land type in the attributes map, as represented by an AttributesPixel structure, that corresponds to a given display colour. Function prototype AttributesPixel CExtAPI::calc_AM_GetIDfromColour(COLORREF col); text/html 2017-08-31T06:29:08+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:calc_am_getpixelcolour&rev=1504160948&do=diff API Description Get the display colour of a pixel value in an attributes map. Function prototype COLORREF CExtAPI::calc_AM_GetPixelColour(AttributesPixel AMpxl); Arguments Name Type Comment AMpxl AttributesPixel A pixel value from an attributes map, the display colour of which is to be determined. Return value A Windows COLORREF structure containing the colour of the land type. A value of magenta {R,G,B} = {255, 0, 255} is returned in the case of an error, as this colour is too p… text/html 2017-08-31T05:23:10+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:combosel_getcursel&rev=1504156990&do=diff Description Get the selected option in a combination selector variable (VarID_combosel), as a C-style string. Function prototype const char* CExtAPI::combosel_GetCurSel(ZVAR hComboSel); Arguments Name Type Comment hComboSel ZVAR A ZVAR handle of type VarID_combosel. Return value A pointer to a C-style string containing the selected option in the combosel variable, or null if an error has occurred. text/html 2017-08-31T07:00:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:combosel_getoptions&rev=1504162830&do=diff Description Get the pipe-delimited ('') string of options from a combination selector variable (VarID_combosel). Function prototype const char* CExtAPI::combosel_GetOptions(ZVAR hComboSel); Arguments Name Type Comment hComboSel ZVAR A ZVAR handle of type VarID_combosel. Return value A pointer to a C-style string containing the options string, delimited by pipes (''). text/html 2017-08-31T07:20:41+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:combosel_initcs&rev=1504164041&do=diff Description Initialise the options and current selection of a combination selection window variable (VarID_combosel). Function prototype bool CExtAPI::combosel_InitCS(ZVAR hComboSel, const char* lpOptionsStr, const char* lpCurSel); Arguments Name Type Comment hComboSel ZVAR A ZVAR handle to a variable initialised as type VarID_combosel. lpOptionsStr const char* A pointer to a C-style string, containing a pipe-delimited ('') string of options. lpCurSelStr const char* … text/html 2017-08-31T06:48:11+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:combosel_setcursel&rev=1504162091&do=diff Description Set the option in a combination selector window (VarID_combosel) that will be selected when the window is shown. Function prototype bool CExtAPI::combosel_SetCurSel(ZVAR hComboSel, const char* lpCurSelStr); Arguments Name Type Comment hComboSel ZVAR A ZVAR handle of type VarID_combosel. lpCurSelStr const char* A pointer to a C-style string, containing the name of the option to be selected. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:42:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:combosel_setoptions&rev=1504158156&do=diff Description Set the options in a ComboSelector window. Function prototype bool CExtAPI::combosel_SetOptions(ZVAR hComboSel, const char* lpOptionsStr); Arguments Name Type Comment hComboSel ZVAR A ZVAR handle of type VarID_combosel. lpOptionsStr const char* A pointer to a C-style string, containing a pipe-delimited ('') string of options. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:06:47+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czcolour_create&rev=1504159607&do=diff Description Create a new colour variable. Function prototype bool CzColour::Create(const char* lpVarName = 0); Arguments Name Type Comment lpVarName const char* A handle to a C-style string containing the name of the string variable to be created. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:58:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czcolour_czcolour&rev=1504162684&do=diff Description Create and initialise a CzColour object. Function prototype void CzColour::CzColour(void); Arguments None. Return value None. Comments None. text/html 2017-08-31T05:01:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czcolour_getb&rev=1504155691&do=diff Description Get the blue component of an CzColour object. Function prototype unsigned char CzColour::GetB(void); Arguments None. Return value The blue component of the CzColour object, as an unsigned 8-bit integer. Comments None. text/html 2017-08-31T07:21:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czcolour_getcolorref&rev=1504164096&do=diff Description Get the colour of the CzColour object as an MS Windows COLORREF struct. Function prototype COLORREF CzColour:GetCOLORREF(); Arguments None. Return value A COLORREF struct containing the colour of the CzColour object. Comments None. text/html 2017-08-31T05:18:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czcolour_getg&rev=1504156736&do=diff Description Get the green component of an CzColour object. Function prototype unsigned char CzColour::GetG(void); Arguments None. Return value The green component of the CzColour object, as an unsigned 8-bit integer. Comments None. text/html 2017-08-31T05:49:06+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czcolour_getr&rev=1504158546&do=diff Description Get the red component of an CzColour object. Function prototype unsigned char CzColour::GetR(void); Arguments None. Return value The red component of the CzColour object, as an unsigned 8-bit integer. Comments None. text/html 2017-08-31T04:36:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czcolour_setrgb&rev=1504154216&do=diff Description Set the red, green and blue components of a CzColour object. Function prototype bool CzColour::SetRGB(unsigned char R, unsigned char G, unsigned char B); Arguments Name Type Comment R unsigned char The red component of the desired colour. G unsigned char The green component of the desired colour. B unsigned char The blue component of the desired colour. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:34:39+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czcolour_setrgb_2&rev=1504164879&do=diff Description Set the red, green and blue components of a CzColour object, using an MS Windows COLORREF struct. Function prototype bool CzColour::SetRGB(COLORREF ColRef); Arguments Name Type Comment ColRef COLORREF The COLORREF struct containing the colour to which the CzColour object shall be set. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:57:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czmap_opendirectinterface&rev=1504162633&do=diff Description Create local copy of a map's memory handles, so that calls to CzMap::GetPixel and CzMap::SetPixel do not need to make API calls, and thereby execute more quickly. Files Declaration CzMap.h Implementation CzMap.cpp Function prototype bool CzMap::OpenDirectInterface(); text/html 2017-08-31T07:31:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czmaptile_opendirectinterface&rev=1504164688&do=diff Description Create local copy of a map tile's memory handles, so that calls to CzMapTile::GetPixel and CzMapTile::SetPixel do not need to make API calls, and thereby execute more quickly. Files Declaration CzMapTile.h Implementation CzMapTile.cpp Function prototype bool CzMapTile::OpenDirectInterface(); text/html 2017-08-31T05:02:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_append&rev=1504155770&do=diff Description Append a text string to the end of a CzStr object. Function prototype const char* CzStr::Append(const char* lpNewText); Arguments Name Type Comment lpNewText const char* A C-style handle to the string to be appended to the CzStr object. Return value A C-style handle to the new CzStr string data. text/html 2017-08-31T06:43:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_appendchar&rev=1504161812&do=diff Description Append a character to the end of a CzStr object. Function prototype const char* CzStr::AppendChar(char c); Arguments Name Type Comment c char The character to be appended to the string. Return value A C-style handle to the new CzStr string data. text/html 2017-08-31T06:09:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_compare&rev=1504159771&do=diff Description Compare the contents of a CzStr object with a C-style string (case sensitive). Function prototype int Compare(const char* lpText); Arguments Name Type Comment lpText const char* A handle to a C-style string, the contents of which are to be compared with the string in a CzStr object. Return value Zero if lpText is identical to the string contained in the CzStr object, and non-zero otherwise. See strcmp for meaning of non-zero values. text/html 2017-08-31T06:20:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_comparenocase&rev=1504160430&do=diff Description Compare the contents of a CzStr object with a C-style string (case insensitive). Function prototype int CompareNoCase(const char* lpText); Arguments Name Type Comment lpText const char* A handle to a C-style string, the contents of which are to be compared with the string in a CzStr object. Return value Zero if lpText is identical to the string contained in the CzStr object (ignoring case differences), and non-zero otherwise. See strcmp for meaning of non-zero values. text/html 2017-08-31T07:13:22+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_create&rev=1504163602&do=diff Description Create a new string variable. Function prototype bool CzStr::Create(const char* lpVarName = 0); Arguments Name Type Comment lpVarName const char* A handle to a C-style string containing the name of the string variable to be created. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:51:46+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_czstr&rev=1504155106&do=diff Description Create and initialise a CzStr object. Function prototype void CzStr:CzStr(void); Arguments None. Return value None. Comments None. text/html 2017-08-31T04:52:55+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_find&rev=1504155175&do=diff Description Finds the first instance of a character sequence in a string variable. Function prototype int Find(const char* lpText, int StartPos = 0); Arguments Name Type Comment lpText const char* A handle to a C-style string containing the search string. StartPos int The position in the string variable at which the search will start. Return value -1 if an error occurred, and zero or more if the string is found. text/html 2017-08-31T04:47:47+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_getat&rev=1504154867&do=diff Description Retrieve a character from a string. Function prototype char CsZtr::GetAt(int index); Arguments Name Type Comment index int The index of the character in the string. Return value The value of the character at the given position. If out of bounds, zero is returned. text/html 2017-08-31T06:56:16+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_getlength&rev=1504162576&do=diff Description Get the length of a string in a CzStr object. Function prototype long CzStr::GetLength(); Arguments None. Return value The length of the string contained in the CzStr object. Comments None. text/html 2017-08-31T06:31:08+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_gettext&rev=1504161068&do=diff Description Retrieve the contents of a string variable, as a C-style string handle. Function prototype const char* CzStr::GetText(); Arguments None. Return value Null if an error occurred, and a non-null handle to a C-style string otherwise. text/html 2017-08-31T04:19:15+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_isstr&rev=1504153155&do=diff Description A test for whether the string data in a CzStr object is identical to another C-style string. Function prototype bool CzStr::IsStr(const char* lpTextStr); Arguments Name Type Comment lpTextStr const char* A hancle to the C-style string to be compared to the contents of the CzStr object. Return value True if the contents of the string pointed to by lpTextStr is identical to the string data in the CzStr object. False otherwise. text/html 2017-08-31T04:43:38+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czstr_settext&rev=1504154618&do=diff Description Set the contents of a string variable using a a C-style string handle. Function prototype bool CzStr::SetText(const char* lpTextStr); Arguments Name Type Comment lpTextStr const char* A handle to a C-style string, the value of which is to be stored in the CzStr object. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:23:20+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_attach&rev=1504157000&do=diff Description Attach an existing ZVAR variable handle to this CzVar object. Subsequent calls to CzVar methods, or those of derived classes, will operate on the ZVAR handle provided. Function prototype bool CzVar::Attach(ZSTR hStr); Arguments Name Type Comment hStr ZVAR A ZVAR handle to an existing variable. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:04:40+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_copyvalue&rev=1504163080&do=diff Description Copy the value of another variable. Function prototype bool CzVar::CopyValue(ZVAR hVarSrc); Arguments Name Type Comment hVarSrc ZVAR a ZVAR handle to the variable to be copied. Return value False if: * The source variable is an invalid handle. * The source variable is not initialised. * The variable type cannot be copied (see below). text/html 2017-08-31T04:37:52+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_create&rev=1504154272&do=diff Description Create a new variable and attach it to this CzVar object. Function prototype bool CzVar::Create(long VarID, const char* lpVarName = 0); Arguments Name Type Comment VarID long The variable type ID of the variable to be created. lpVarName const char* A handle to a C-style string containing the name of the new variable. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:21:07+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_czvar&rev=1504153267&do=diff Description Create a new CzVar object. Function prototype CzVar::CzVar(void); Arguments None. Return value None. Comments Please note that the CzVar object is not attached to a variable handle following construction. To use the CzVar object, you must first either create a variable using Create, attach an existing variable using Attach, or retrieve a named variable using GetByName. text/html 2017-08-31T05:12:16+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_delete&rev=1504156336&do=diff Description Delete the variable wrapped by this CzVar object. Function prototype bool CzVar::Delete(void); Arguments None. Return value False if an error occurred, and true otherwise. Comments This function is equivalent to the API function var_Delete. Please refer to the documentation of that function for additional information. text/html 2011-01-13T03:28:12+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_editui&rev=1294889292&do=diff Description Edit the value of the variable using L3DT's standard variable editing graphical user interface. Function prototype bool CzVar::EditUI(const char* lpPrompt, unsigned long Flags, ZLIST hOptions); Arguments Name Type Comment lpPrompt const char* A pointer to a C-style string containing the title of the edit dialog. If null is given, a default title is used. Flags unsigned long Reserved. hOptions ZLIST Reserved. Return value False if: text/html 2017-08-31T06:37:45+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_getbyname&rev=1504161465&do=diff Description Retrieve a variable by name and attach it to this CzVar object. Function prototype bool CzVar::GetByName(const char* lpVarName); Arguments Name Type Comment lpVarName const char* A pointer to a C-style string naming the variable to be retrieved. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:31:23+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_getname&rev=1504153883&do=diff Description Retrieve the name string of a variable. Function prototype const char* CzVar::GetName(void); Arguments None Return value Null if an error occurred, and a non-null pointer to a C-style string otherwise. Comments This function is equivalent to the API function var_GetName. Please refer to the documentation of that function for additional information. text/html 2017-08-31T04:35:29+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_gettypeid&rev=1504154129&do=diff Description Retrieve the type ID of the variable attached to this CzVar object. Function prototype long CzVar::GetTypeID(void); Arguments None. Return value Zero if an error occurred or the variable is not initialised, and a non-zero variable type ID otherwise (can be positive or negative.) text/html 2017-08-31T05:17:19+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_gettypename&rev=1504156639&do=diff Description Get the name, as a string, of the type of variable attached to this CzVar object. Function prototype bool CzVar::GetTypeName(ZVAR hStringVar); Arguments Name Type Comment hStringVar ZVAR A ZVAR handle to a user-supplied string variable (created with var_Create, var_CreateTemp or list_CreateItem.) Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:21:15+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_getvalue&rev=1504164075&do=diff Description Retrieve the value of the variable attached to this CzVar object, ensuring first it is of the correct variable type. Function prototype bool CzVar::GetValue(long VarID, void* pValue); Arguments Name Type Comment VarID long The expected type ID of the variable. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, ready to receive the value from the variable. Return value False if: text/html 2017-08-31T05:27:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_getzvar&rev=1504157251&do=diff Description Retrieve the ZVAR handle to the variable wrapped by the CzVar object. Function prototype ZVAR CzVar::GetZVAR(void); Arguments None. Return value Null if an error occurred or the CzVar object is not attached to a variable. Otherwise, a valid non-null ZVAR handle is returned. text/html 2017-08-31T05:16:07+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_istype&rev=1504156567&do=diff Description Test whether the variable to which this CzVar object is attached is initialised as a given type ID. Function prototype bool CzVar::IsType(long VarID); Arguments Name Type Comment VarID long A long integer containing the variable type ID to be tested. Return value False if the variable is not initialised or is of a type other than that given by VarID, and true otherwise. text/html 2017-08-31T06:52:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_release&rev=1504162370&do=diff Description Release the variable handle to which the CzVar object is attached. The variable is not deleted from Zeolite shared memory, but calls to member functions of the CzVar object will no longer access the variable. Function prototype bool CzVar::Release(void); text/html 2017-08-31T07:15:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_rename&rev=1504163702&do=diff Description Change the name of a variable. Function prototype bool CzVar::Rename(const char* lpNewName); Arguments Name Type Comment lpNewName const char* A pointer to a C-style string containing the new name of the variable. Return value False if: text/html 2017-08-31T07:32:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_setvalue&rev=1504164755&do=diff Description Set the value of the variable attached to this CzVar object, ensuring first it is of the correct variable type. Function prototype bool CzVar::SetValue(long VarID, void* pValue); Arguments Name Type Comment VarID long The expected type ID of the variable. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, containing the value to be set. Return value False if: text/html 2017-08-31T07:20:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_setvaluetext&rev=1504164013&do=diff Description Set the value of the variable attached to this CzVar object using from an ASCII character string. Files Declaration zVar.h Implementation zVar.cpp Function prototype bool CzVar::SetValueText(const char* lpValueText); Arguments Name Type Comment lpValueText const char* A handle to a C-style string containing the value (as text) to which the variable will be set. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:25:57+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:czvar_setvarref&rev=1504157157&do=diff Description Set the variable attached to this CzVar object to be a reference/alias of another variable. Function prototype bool CzVar::SetVarRef(ZVAR hSrcVar); Arguments Name Type Comment hSrcVar ZVAR A ZVAR handle to the variable that shall be aliased by the variable attached to the CzVar object. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:22:09+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:dirsel_getdirname&rev=1504153329&do=diff Description Retrieve the selected directory name from a directory selector variable (VarID_dirsel). Function prototype const char* CExtAPI::dirsel_GetDirname(ZVAR hDirSel); Arguments Name Type Comment hDirSel ZVAR A ZVAR handle to a VarID_dirsel variable, the selected directory name of which is to be retrieved. Return value A valid, null-terminated C-style string containing the selected directory name, or a null pointer if an error occurred. text/html 2017-08-31T07:13:26+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:dirsel_initds&rev=1504163606&do=diff Description Initialise the contents of a directory selector variable (VarID_dirsel). Function prototype bool CExtAPI::dirsel_InitDS(ZVAR hDirSel, const char* lpStartDir); Arguments Name Type Comment hDirSel ZVAR A ZVAR handle to a variable, which must be of type VarID_dirsel. lpStartDir const char* A handle to a C-style string containing the initial directory of the directory selector variable. The directory name must be the full path, and relative paths are not supported.… text/html 2017-08-31T07:00:11+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:file_fileexists&rev=1504162811&do=diff Description Test whether a file exists on the filesystem. Function prototype bool CExtAPI::file_FileExists(const char* lpFileName); Arguments Name Type Comment lpFileName const char* A handle to a C-style string containing the filename, the existence of which is to be determined. Return value False if the file does not exist or an error occurred, and true otherwise. text/html 2017-08-31T05:47:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:file_getdir&rev=1504158441&do=diff Description Get the full path to the directory containing the specified file. Function prototype bool CExtAPI::file_GetDir(ZVAR hStr, const char* lpFileName); Arguments Name Type Comment hStr ZVAR A ZVAR handle to a string variable to receive the directory string. lpFileName const char* A handle to a C-style string containing the file name, the directory of which is to be determined. Return value False if no directory was found or if an error occurred, and true otherwise (with … text/html 2017-08-31T05:18:03+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:file_getext&rev=1504156683&do=diff Description Get the file extension of a filename. Function prototype bool CExtAPI::file_GetExt(ZVAR hStr, const char* lpFileName); Arguments Name Type Comment hStr ZVAR A ZVAR handle to a string variable to receive the extension string. lpFileName const char* A handle to a C-style string containing the file name, the extension of which is to be determined. Return value False if no extension was found or if an error occurred, and true otherwise (with hStr containing the file ext… text/html 2017-08-31T07:25:08+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:file_getfilenamenodir&rev=1504164308&do=diff Description Get the filename of a file, without the directory path. Function prototype bool CExtAPI::file_GetFilenameNoDir(ZSTR hStr, const char* lpFileName); Arguments Name Type Comment hStr ZSTR A ZSTR handle to a string variable to receive the directory-less filename string. lpFileName const char* A handle to a C-style string containing the file name, the directory of which is to be removed. Return value False if an error occurred, and true otherwise (with hStr containing t… text/html 2017-08-31T07:09:34+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:file_getfilenamenoext&rev=1504163374&do=diff Description Get the filename of a file, without the file extension. If a full path to a file is provided, it will be included also. Function prototype bool CExtAPI::file_GetFilenameNoExt(ZVAR hStr, const char* lpFileName); Arguments Name Type Comment hStr ZVAR A ZVAR handle to a string variable to receive the extension-less filename string. lpFileName const char* A handle to a C-style string containing the file name, the extension of which is to be removed. Return value False i… text/html 2017-08-31T07:15:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:file_isabsolutepath&rev=1504163704&do=diff Description Test whether a given path name is an absolute path (returns true) or a relative path (returns false). Files Declaration zFile.h Implementation zFile.cpp Function prototype bool zfile_IsAbsolutePath(const char* lpPathName); Arguments Name Type Comment lpPathName const char* A C-style string containing the path to be tested. Return value True if the given path is a fully qualified absolute path, and false otherwise. text/html 2017-08-31T06:29:12+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:filesel_getfilename&rev=1504160952&do=diff Description Retrieve the selected filename from a file selector variable (VarID_filesel). Function prototype const char* CExtAPI::filesel_GetFilename(ZVAR hFileSel); Arguments Name Type Comment hFileSel ZVAR A ZVAR handle to a VarID_filesel variable, the selected filename of which is to be retrieved. Return value A valid, null-terminated C-style string containing the selected filename, or a null pointer if an error occurred. text/html 2011-01-13T03:28:18+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:filesel_initfs&rev=1294889298&do=diff Description Initialise the contents of a file selector variable (VarID_filesel). Function prototype bool CExtAPI::filesel_InitFS(ZVAR hFileSel, bool OpenFileFlag, const char* lpFileName, const char* lpFilterStr, const char* lpDefaultExt, const char* lpDefaultDir); text/html 2017-08-31T06:11:40+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_create&rev=1504159900&do=diff Description Create an instance of a file format handler for a particular project map. This function, or format_CreateGeneric, must be called at least once by a file input/output plugin before it can be used to save or load map files. Function prototype ZFORMAT CExtAPI::format_Create(const char* lpMapName, const char* lpLongName, const char* lpFileExt, const char* lpNativeProgramName); text/html 2017-08-31T06:40:47+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_creategeneric&rev=1504161647&do=diff Description Create an instance of a file format handler for a particular map type. This function, or format_Create, must be called at least once by a file input/output plugin before it can be used to save or load map files. Function prototype ZFORMAT CExtAPI::format_CreateGeneric(long MapTypeID, const char* lpLongName, const char* lpFileExt, const char* lpNativeProgramName); text/html 2017-08-31T06:30:57+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getactiveformat&rev=1504161057&do=diff Description Retrieve the format currently used for a particular map layer within the project, or else the default format for that map layer type. Function prototype ZFORMAT CExtAPI::format_GetActiveFormat(const char* lpMapName, long MapTypeID); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name of the map for which a format will be retrieved (may be null). See project_GetMap for list of valid names. MapTypeID long The map type ID for… text/html 2017-08-31T04:17:48+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getdefaultformat&rev=1504153068&do=diff Description Retrieve the default file format handler for a particular map layer. The default format is set in the file preferences window. Function prototype ZFORMAT CExtAPI::format_GetDefaultFormat(const char* lpMapName, long MapTypeID); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name of the map for which the default format will be retrieved (may be null). See project_GetMap for list of valid names. MapTypeID long The map type ID… text/html 2017-08-31T05:17:16+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getext&rev=1504156636&do=diff Description Get the file extension of a ZFORMAT as a C-style string pointer. Function prototype const char* CExtAPI::format_GetExt(ZFORMAT hFormat); Arguments Name Type Comment hFormat ZFORMAT A ZFORMAT handle, the file extension of which is to be retrieved. Return value Null if an error occurred, or otherwise a pointer to a C-style string containing the file extension of the format. text/html 2017-08-31T04:20:06+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getflags&rev=1504153206&do=diff Description Retrieve the file format support flags for a file format handler variable (VarID_format). Function prototype unsigned long CExtAPI::format_GetFlags(ZFORMAT hFormat); Arguments Name Type Comment hFormat ZFORMAT A handle to the file format handler variable, which must be initialised as type VarID_format. Return value An unsigned long integer representing a bitfield combination of file format flags. Please refer to the format_SetFlags2 comments for a list of values a… text/html 2017-08-31T06:27:06+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getformatbyext&rev=1504160826&do=diff Description Retrieve a handle to a format, specified by its file extension, for a particular map type or map name. Function prototype ZFORMAT CExtAPI::format_GetFormatByExt(const char* lpMapName, long MapTypeID, const char* lpFileExt); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name of the map for which a format will be retrieved (may be null). See project_GetMap for list of valid names. MapTypeID long The map type ID for which th… text/html 2017-08-31T06:32:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getformatbyext2&rev=1504161156&do=diff Description Retrieve a handle to a format, specified by its file extension, that is compatible with a user-supplied map handle. Function prototype ZFORMAT CExtAPI::format_GetFormatByExt2(ZMAP hMap, const char* lpFileExt); Arguments Name Type Comment hMap ZMAP A ZMAP handle to an initialised map variable. lpFileExt const char* A handle to a C-style string containing the file extension of the format to be retrieved. Return value A null pointer if an error occurred, and a valid non… text/html 2017-08-31T07:06:03+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getformatlist&rev=1504163163&do=diff Description Retrieve the list of available formats for a particular map type or map name. Function prototype ZLIST CExtAPI::format_GetFormatList(const char* lpMapName, long MapTypeID); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name of the map for which the format list will be retrieved (may be null). See project_GetMap for list of valid names. MapTypeID long The map type ID for which the format list will be retrieved (may be zero… text/html 2017-08-31T07:26:27+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getformatlist2&rev=1504164387&do=diff Description Retrieve the list of available formats that are compatible with a user-supplied map handle. Function prototype ZLIST CExtAPI::format_GetFormatList2(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to an initialised map variable, the a list of compatible formats for which is to be retrieved . Return value A null pointer if an error occurred, and a valid non-null handle to a ZLIST variable otherwise. text/html 2017-08-31T07:01:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getoptionlist&rev=1504162910&do=diff Description Retrieve the list of options for a file format, as typically set by the CExtAPI::format_SetOptionValue function. Function prototype ZLIST CExtAPI::format_GetOptionList(ZFORMAT hFormat); Arguments Name Type Comment hFormat ZFORMAT A ZFORMAT handle, the options list of which is to be retrieved. Return value NULL if an error occurred, and a valid ZLIST handle otherwise. text/html 2017-08-31T07:22:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_getoptionvalue&rev=1504164150&do=diff Description Retrieve the value of an option in a file format. Function prototype bool CExtAPI::format_GetOptionValue(ZFORMAT hFormat, const char* lpOptionName, long VarID, void* pValue); Arguments Name Type Comment hFormat ZFORMAT A ZFORMAT handle, an option of which is to be retrieved. lpOptionName const char* A pointer to a C-style string, containing the option name. VarID long The expected integer VarID of the option, such as VarID_int. pValue void* A pointer (of unknown t… text/html 2017-08-31T05:34:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_ismosaic&rev=1504157653&do=diff Description Determine whether a file format supports mosaic maps. Function prototype bool CExtAPI::format_IsMosaic(ZFORMAT hFormat); Arguments Name Type Comment hFormat ZFORMAT A handle to a file format, of which the mosaic support is to be ascertained. Return value False if: text/html 2017-08-31T06:57:09+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_isnative&rev=1504162629&do=diff Description Determine whether a file format has full 'native' support. Please see for the distinction between native and non-native support. Function prototype bool CExtAPI::format_IsNative(ZFORMAT hFormat); Arguments Name Type Comment hFormat ZFORMAT A handle to a format variable, the native support (or otherwise) of which is to be ascertained. Return value False if: text/html 2017-08-31T05:07:39+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_setflags&rev=1504156059&do=diff Description format_SetFlags2 Set the file format capabilities flags (native/non-native, and mosaic/non-mosaic). Function prototype bool CExtAPI::format_SetFlags(ZFORMAT hFormat, bool Native, bool Mosaic); Arguments Name Type Comment hFormat ZFORMAT A ZFORMAT handle, the flags of which are to be set. Native bool This may be true only if the format can read and write maps with no (or minimal) data loss. If this is a heightfield format, the file must preserve vertical scaling info… text/html 2017-08-31T07:14:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_setflags2&rev=1504163690&do=diff Description Set the file format support flags for a file format handler variable (VarID_format). Function prototype bool CExtAPI::format_SetFlags2(ZFORMAT hFormat, unsigned long Flags); Arguments Name Type Comment hFormat ZFORMAT A 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 v… text/html 2017-08-31T07:14:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_setinfostr&rev=1504163682&do=diff Description Set the information string displayed for a file format in in L3DT's file preferences dialog. Function prototype bool CExtAPI::format_SetInfoStr(ZFORMAT hFormat, const char* lpInfoStr); Arguments Name Type Comment hFormat ZFORMAT A ZFORMAT handle to a format variable, the information string of which is to be set. lpInfoStr const char* A handle to a C-style string containing the information string. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:40:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:format_setoptionvalue&rev=1504161613&do=diff Description Set the value of an option in a file format, as typically retrieved by the CExtAPI::format_GetOptionValue function. Function prototype bool CExtAPI::format_SetOptionValue(ZFORMAT hFormat, const char* lpOptionName, long VarID, void* pValue); text/html 2017-08-31T07:05:34+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:initapi&rev=1504163134&do=diff Description Initialise the CExtAPI instance. This function must be called before any other member functions of CExtAPI. Function prototype bool CExtAPI::InitAPI(FARPROC pFunc, void* hID); Arguments Name Type Comment pFunc FARPROC A parent application function handle. hID void* A plugin identifier handle. Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T05:20:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_append&rev=1504156813&do=diff Description Append the contents of one list to the end of another. Function prototype bool CExtAPI::list_Append(ZLIST hList, ZLIST hList2); Arguments Name Type Comment hList ZLIST A handle to a list. hList2 ZLIST A handle to the list, the contents of which are to be appended to hList. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:12:20+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_createitem&rev=1504163540&do=diff Description Create a variable in a list. Function prototype ZVAR CExtAPI::list_CreateItem(ZLIST hList, long VarID, const char* lpVarName); Arguments Name Type Comment hList ZLIST A ZLIST handle, to which an item will be added. VarID long The VarID of the new item. lpVarName const char* The name of the new item. If null, the variable is unnamed. Return value Null if an error occurred, and a valid ZVAR handle otherwise. text/html 2017-08-31T04:43:09+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_delall&rev=1504154589&do=diff Description Delete all items from a list. Function prototype bool CExtAPI::list_DelAll(ZLIST hList); Arguments Name Type Comment hList ZLIST A ZLIST handle, all the items of which are to be deleted. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:30:19+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_delitema&rev=1504161019&do=diff Description Delete an item from a list, specified by its name. Function prototype bool CExtAPI::list_DeleteItemA(ZLIST hList, const char* lpVarName); Arguments Name Type Comment hList ZLIST A ZLIST handle, an item of which is to be deleted. lpVarName const char* A pointer to a C-style string, giving the name of the variable to be deleted. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:15:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_delitemi&rev=1504152900&do=diff Description Delete an item from a list, specified by its index in the list. Function prototype bool CExtAPI::list_DelItemI(ZLIST hList, long index); Arguments Name Type Comment hList ZLIST A ZLIST handle, an item of which is to be deleted. index long The index of the variable to be deleted. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:05:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_getitema&rev=1504159531&do=diff Description Retrieve a ZVAR handle to an item in a list, specified by its name. Function prototype ZVAR CExtAPI::list_GetItemA(ZLIST hList, const char* lpVarName); Arguments Name Type Comment hList ZLIST A ZLIST handle, an item of which is to be retrieved. lpVarName const char* A pointer to a C-style string, giving the name of the variable to be retrieved. Return value NULL if an error occurred, and a valid ZVAR otherwise. text/html 2017-08-31T05:43:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_getitemi&rev=1504158236&do=diff Description Retrieve a ZVAR handle to an item in a list, specified by its index in the list. Function prototype ZVAR CExtAPI::list_GetItemI(ZLIST hList, long index); Arguments Name Type Comment hList ZLIST A ZLIST handle, an item of which is to be retrieved. index long The index of the item to be retrieved. Indices are zero-based (C-style). Return value NULL if an error occurred, and a valid ZVAR otherwise. text/html 2017-08-31T04:15:37+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_getlist&rev=1504152937&do=diff Description Retrieve a ZLIST from the parent application. Function prototype ZLIST CExtAPI::list_GetList(const char* lpListName); Arguments Name Type Comment lpListName const char* The name of the list to be retrieved. Names are case sensitive, and '.' denotes a nested list (e.g. 'hello.howareyou' accesses the list 'howareyou' in the list 'hello'. Return value Null if an error occurred, and a valid ZLIST otherwise. text/html 2017-08-31T06:29:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_nitems&rev=1504160940&do=diff Description Get the number of items in a list. Function prototype long CExtAPI::list_nItems(ZLIST hList); Arguments Name Type Comment hList ZLIST A ZLIST handle, the number of items in which are to be counted. Return value The number of items in the list. Zero is returned in the case of an error. text/html 2017-08-31T04:57:41+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_sorta&rev=1504155461&do=diff Description Sort an item in a list to another index. In list_SortA, the item to be sorted is specified by its name (compare: list_SortI). Function prototype bool CExtAPI::list_SortA(ZLIST hList, const char* lpItemName, long To); Arguments Name Type Comment hList ZLIST A handle to a ZLIST variable containing the item to be sorted. lpItemName const char* A handle to a C-style string containing the name of the item to be sorted. To long The desired index of the item. Return value… text/html 2017-08-31T07:15:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:list_sorti&rev=1504163700&do=diff Description Sort an item in a list to another index. In list_SortI, the item to be sorted is specified by its current location (compare: list_SortA). Function prototype bool CExtAPI::list_SortI(ZLIST hList, int From, int To); Arguments Name Type Comment hList ZLIST A handle to a ZLIST variable containg the item to be sorted. From int The current index of the item to be sorted. To int The desired index of the item. Return value False if an error occurred, and true… text/html 2017-08-31T06:17:45+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_clearmipmaps&rev=1504160265&do=diff Description Clear and de-allocate the mipmaps for a map. Function prototype bool CExtAPI::map_ClearMipmaps(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A handle to a map variable, the mipmaps of which are to be cleared. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:51:53+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_combinemosaic&rev=1504155113&do=diff Description Combine a mosaic map into an un-tiled 'all-in-RAM' map. Function prototype bool CExtAPI::map_CombineMosaic(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A handle to the map variable that shall be converted from a mosaic map to an all-in-RAM map. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:44:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_exportmap&rev=1504158282&do=diff Description Export a map as a file, optionally with a different map size. Function prototype bool CExtAPI::map_ExportMap(ZMAP hMap, const char* lpFileName, ZFORMAT hFormat, long nx, long ny); Arguments Name Type Comment hMap ZMAP A handle to the map to be exported. lpFileName const char* A C-style string containing the name of the output file. hFormat ZFORMAT A handle to the format to be used to save the file. If null, the format is guessed from the file extension. nx long Th… text/html 2017-08-31T06:26:01+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_exportmosaic&rev=1504160761&do=diff Description Export a mosaic map, and all its tiles, to a different file name/path. Function prototype bool CExtAPI::map_ExportMosaic(ZMAP hMap, const char* lpFileName, ZFORMAT hFormat, long nx, long ny, long TileSize, const char* lpProjMapName); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the mosaic map that is to be exported. lpFileName const char* A handle to a C-style string that contains the full path-name and extensions of the output mosaic master file. hFormat ZF… text/html 2017-08-31T04:59:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_free&rev=1504155572&do=diff Description De-allocate a map, release memory, etc. Function prototype bool CExtAPI::map_free(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map to be freed. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:28:41+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_genmipmaps2&rev=1504157321&do=diff Description Generate the multi-resolution mipmaps for a given map. These mipmaps are smaller, sub-sampled versions used in level-of-detail algorithms such as texture rendering in Sapphire. Function prototype bool CExtAPI::map_GenMipmaps2(ZMAP hMap, long ResStep, long MaxLevel, long TileSize); text/html 2017-08-31T06:08:03+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getbusyflag&rev=1504159683&do=diff Description Retrieve the busy flag for a map. Please see map_SetBusyFlag for the meaning of this flag. Function prototype bool CExtAPI::map_GetBusyFlag(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the busy flag of which is to be retrieved. Return value True if: text/html 2017-08-31T05:11:05+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getdataptr&rev=1504156265&do=diff Description Retrieve the raw handle to map memory. Function prototype void* CExtAPI::map_GetDataPtr(ZMAP hMap); Arguments Name Type Comment hMap ZMAP The ZMAP handle of the map for which the data handle is to be retrieved. Return value A null pointer if: text/html 2017-08-31T06:55:14+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getfilename&rev=1504162514&do=diff Description Retrieve the full pathname of the file in which a given map has been saved (for example, 'C:\My maps\map1.hff'). Function prototype const char* CExtAPI::map_GetFilename(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A handle to a map variable, the saved filename of which is to be retrieved. Return value A null pointer if the map has not yet been saved or an error occurred, and otherwise a valid non-null handle to a C-style string containing the full path of the file i… text/html 2017-08-31T06:59:18+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getflag&rev=1504162758&do=diff Description Retrieve the state of a flag for a map. See map_SetFlag for the list of supported flags, and their meanings. Function prototype bool CExtAPI::map_GetFlag(ZMAP hMap, long FlagID); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, a flag of which is to be retrieved. FlagID long The ID of the flag to be retrieved. See map_SetFlag for allowed values. Return value True if the flag exists, and false otherwise. text/html 2017-08-31T07:21:34+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getformat&rev=1504164094&do=diff Description Retrieve the file format used to save a given map to disk. Function prototype ZFORMAT CExtAPI::map_GetFormat(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A handle to a map variable, the saved file format of which is to be retrieved. Return value A null handle if the map has not been saved or an error occurred, and a valid non-null ZFORMAT handle otherwise. text/html 2011-01-13T03:28:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getheight&rev=1294889315&do=diff Description Get the number of pixels in the y-axis of the map. Function prototype long CExtAPI::map_GetHeight(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the height of which is to be retrieved. Return value Zero if an error occurred or the map is uninitialised, and non-zero otherwise. text/html 2011-01-13T03:28:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_gethorizscale&rev=1294889315&do=diff Description Get the distance between neighbouring pixels in a map in the x- and y-axes, measured in metres. Function prototype float CExtAPI::map_GetHorizScale(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, the horizontal scaling of which is to be retrieved. Return value Zero if an error occurred, and greater than zero otherwise. text/html 2017-08-31T06:59:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmap&rev=1504162789&do=diff project_GetMap Description Retrieve a ZMAP handle to a map. Function prototype ZMAP CExtAPI::map_GetMap(LPCSTR lpMapName); Arguments Name Type Comment lpMapName LPCSTR A pointer to a C-style string containing the name of the map to be retrieved. Return value False if an error occurred, and a valid non-nul ZMAP handle otherwise. text/html 2017-08-31T06:45:03+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmaptype&rev=1504161903&do=diff Description Retrieve the map type identifier of a given map. Function prototype long CExtAPI::map_GetMapType(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the type of which is to be retrieved. Return value Zero if an error occurred, or the map was uninitialised. Otherwise, a non-zero (positive or negative) value is returned. Please consult the map type page or 'ExtAPI_defines.h' for a list of valid map types. text/html 2017-08-31T04:38:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getminmaxalt&rev=1504154315&do=diff Description Get the minimum and maximum altitude of a map, in metres. Note this function fails for map types other than MAP_Heightfield and MAP_WaterMap. Function prototype bool CExtAPI::map_GetMinMaxAlt(ZMAP hMap, float& minval, float& maxval); text/html 2017-08-31T05:42:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmipmaplevel&rev=1504158169&do=diff Description Get a mipmap (as a ZMAP handle) for a given map. Function prototype ZMAP CExtAPI::map_GetMipmapLevel(ZMAP hMap, long MipLevel); Arguments Name Type Comment hMap ZMAP A handle to a map variable, a mipmap of which is to be retrieved. MipLevel long The sub-sampling factor of the desired mipmap. See comments below. Return value A null pointer if the desired mipmap does not exist, or if an error occurred. Otherwise, a non-null handle to a map variable is returned. text/html 2017-08-31T06:43:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmipmapmaxlevel&rev=1504161836&do=diff Description Get the maximum mipmap level for a given map. This function is used for bounds checking in calls to map_GetMipmapLevel. Function prototype long CExtAPI::map_GetMipmapMaxLevel(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A handle to a map, the maximum mipmap level of which is to be retrieved. Return value Zero if the map has no mipmaps, and a value larger than 1 otherwise. text/html 2017-08-31T05:45:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmipmapresstep&rev=1504158336&do=diff Description Get the resolution step factor between successive mipmaps for a given map. Function prototype long CExtAPI::map_GetMipmapResStep(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A handle to a map variable, the mipmap resolution step factor of which is to be retrieved. Return value An integer greater than one if mipmaps have been initialised. Otherwise, zero is returned. text/html 2017-08-31T07:12:12+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmosaicflag&rev=1504163532&do=diff Description Get the MosaicFlag for a map, which states whether it is a mosaic or not. Function prototype bool CExtAPI::map_GetMosaicFlag(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, the mosaic flag of which is to be retrieved. Return value False if an error occurred or the map is not a mosaic, and true otherwise. text/html 2017-08-31T06:53:22+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmosaictile&rev=1504162402&do=diff Description Retrieve a mosaic tile handle. Function prototype void* CExtAPI::map_GetMosaicTile(ZMAP hMap, long tx, long ty); Arguments Name Type Comment hMap ZMAP A handle to a map, a tile of which is to be retrieved. tx long The x-coordinate of the tile. ty long The y-coordinate of the tile. Return value A null handle if: text/html 2017-08-31T07:06:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmosaictilesize&rev=1504163164&do=diff Description Get the size, in pixels, of the side-length of the tiles in a mosaic map. Note tiles are always square, even though maps are not. Function prototype long CExtAPI::map_GetMosaicTileSize(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, the mosaic tile size of which is to be retrieved. Return value Zero if an error occurred or the map is not a mosaic, and greater than zero otherwise. text/html 2017-08-31T05:47:08+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmosaictilesx&rev=1504158428&do=diff Description Get the number of tiles in a mosaic in the x-direction. Function prototype long CExtAPI::map_GetMosaicTilesX(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, for which the mosaic tile count in the x-direction is to be retrieved. Return value Zero if an error occurred or the map is not a mosaic, and greater than zero otherwise. text/html 2017-08-31T04:30:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getmosaictilesy&rev=1504153802&do=diff Description Get the number of tiles in a mosaic in the y-direction. Function prototype long CExtAPI::map_GetMosaicTilesY(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, for which the mosaic tile count in the y-direction is to be retrieved. Return value Zero if an error occurred or the map is not a mosaic, and greater than zero otherwise. text/html 2017-08-31T07:24:57+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getnameinproject&rev=1504164297&do=diff Description Retrieve the name of a map as it appears in the project's map list. This is the name used in the project_GetMap and view_ShowMap functions, amongst others. The name is set in the project_CreateMap function, and cannot be changed thereafter. text/html 2011-01-13T03:28:40+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getpixel&rev=1294889320&do=diff Description Get the value of a pixel in a map. Function prototype bool CExtAPI::map_GetPixel(ZMAP hMap, long x, long y, void* pValue); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the pixel of which is to be retrieved. x long The x-coordinate of the pixel. y long The y-coordinate of the pixel. pValue void* A pointer (of unknown type) to the user-supplied entity that shall receive the pixel value. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:27:43+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getpixelsize&rev=1504160863&do=diff Description Get the size in memory of a pixel in the map, measured in bytes. Function prototype long CExtAPI::map_GetPixelSize(ZMAP hMap); Arguments Name Type Comment hMap ZMAP The ZMAP handle to a map, the pixel size of which is to be retrieved. Return value Zero if an error occurred or the map is not initialised, and non-zero otherwise. text/html 2017-08-31T05:32:51+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getsettingslist&rev=1504157571&do=diff Description Retrieve the list of settings for this map. This list is usually empty, but may contain flags, georeferencing data, or other data set by plugins. Function prototype ZLIST CExtAPI::map_GetSettingsList(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the settings list of which is to be retrieved. Return value NULL if an error occurred, and a non-zero handle to a ZLIST variable. text/html 2011-01-13T03:28:41+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getwidth&rev=1294889321&do=diff Description Get the number of pixels in the x-axis of the map. Function prototype long CExtAPI::map_GetWidth(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the width of which is to be retrieved. Return value Zero if an error occurred or the map is uninitialised, and non-zero otherwise. text/html 2017-08-31T05:33:54+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_getwrapflag&rev=1504157634&do=diff Description Get the flag for whether the map is tiled such that the left/right and top/bottom edges wrap around to produce an infinitely repeating map. Function prototype bool CExtAPI::map_GetWrapFlag(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the WrapFlag of which is to be retrieved. Return value False if an error occurred or if the map is non-wrapping. True otherwise. text/html 2017-08-31T04:45:33+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_init&rev=1504154733&do=diff Description Initialise a map, allocate memory, etc. Function prototype TYPE CExtAPI::map_Init(ZMAP hMap, long nx, long ny, long MapTypeID, float HorizScale, bool WrapFlag); Arguments Name Type Comment hMap ZMAP a ZMAP handle to a map variable. nx long The number of pixels in the x-direction (width). ny long The number of pixels in the y-direction (height). MapTypeID long The integer identifier for the map type. HorizScale float The distance between neighbouring pixels in t… text/html 2017-08-31T04:25:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_initmosaic&rev=1504153530&do=diff Description Initialise a map as a mosaic. Function prototype bool CExtAPI::map_InitMosaic(ZMAP hMap, long nx, long ny, long MapTypeID, float HorizScale, bool WrapFlag, const char* lpMosaicFileName, long TileSize, ZFORMAT hFormat, const char* lpProjMapName); text/html 2017-08-31T05:26:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_lininterp&rev=1504157210&do=diff Description Calculate the value of a point in the map via linear interpolation of the nearest pixels. Function prototype bool CExtAPI::map_LinInterp(ZMAP hMap, double dx, double dy, void* pValue); Arguments Name Type Comment hMap ZMAP A handle to a map whose value is to be retrieved. dx double The x-coordinate of the point to be sampled. dy double The y-coordinate of the point to be sampled. pValue void* A pointer (of unknown type) to the user-supplied entity… text/html 2011-01-13T03:28:43+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_loadfile&rev=1294889323&do=diff Description Load a map from a file. Note: this does not work for mosaics. Function prototype bool CExtAPI::map_LoadFile(ZMAP hMap, const char* lpFileName, long MapTypeID, ZFORMAT hFormat, bool SetFlags, bool ShowProgress); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the contents of which are to be loaded from disk. lpFileName const char* A handle to a C-style string containing the full path and extension of the file to be loaded. MapTypeID long A long … text/html 2017-08-31T05:48:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_loadmosaic&rev=1504158480&do=diff Description Open a mosaic map file. Function prototype bool CExtAPI::map_LoadMosaic(ZMAP hMap, const char* lpMosaicFileName); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map that shall be loaded from disk. lpMosaicFileName const char* A handle to a C-style string containing the full path-name of the mosaic master file to be loaded. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:07:10+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_savefile&rev=1504159630&do=diff Description Save a map as a single map file (non-mosaic.) Function prototype bool CExtAPI::map_SaveFile(ZMAP hMap, const char* lpFileName, ZFORMAT hFormat, bool SetFlags, bool ShowProgress); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the contents of which are to be saved to disk. lpFileName const char* A handle to a C-style string containing the full path and extension of the file to be saved. hFormat ZFORMAT A ZFORMAT handle to the format variable to… text/html 2017-08-31T05:14:53+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_savemosaic&rev=1504156493&do=diff Description Save all tiles in a mosaic map to disk (closes RAM cache). Function prototype bool CExtAPI::map_SaveMosaic(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map to be saved. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:08:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_savemosaicas&rev=1504163310&do=diff Description Re-save a mosaic, and all its tiles, with a new name/path. Function prototype bool CExtAPI::map_SaveMosaicAs(ZMAP hMap, const char* lpFileName); Arguments Name Type Comment hMap ZMAP A handle to the mosaic map to be re-saved. lpFileName const char* A handle to a C-style string containing the full path an extension of the new mosaic master file. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:13:39+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_setbusyflag&rev=1504156419&do=diff Description Flag a map to be 'busy', typically meaning the map is in use by a calculation. Maps that are busy cannot be deallocated by map_Free. Function prototype bool CExtAPI::map_SetBusyFlag(ZMAP hMap, bool BusyFlag); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the busy flag of which is to be set. BusyFlag bool The desired state of the busy flag. Return value False if: text/html 2017-08-31T07:22:43+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_setflag&rev=1504164163&do=diff Description Set the value of a flag for a map (see , below.) Function prototype bool CExtAPI::map_SetFlag(ZMAP hMap, long FlagID, bool FlagValue); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, a flag of which is to be set. FlagID long The ID of the flag to be set. See below for allowed values. FlgValue bool The boolean value of the flag to be set. Return value False if: text/html 2017-08-31T05:59:26+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_setformat&rev=1504159166&do=diff Description Change the file format used to save a map to disk. This function will re-save the map in the new format, and change the file extension if necessary. Function prototype bool CExtAPI::map_SetFormat(ZMAP hMap, ZFORMAT hFormat); Arguments Name Type Comment hMap ZMAP A handle to a map variable, the saved file format of which is to be changed. hFormat ZFORMAT A handle to the file format variable that shall be used to save the map. Return value False if an error occ… text/html 2017-08-31T05:35:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_sethorizscale&rev=1504157749&do=diff Description Set the distance between neighbouring pixels in a map in the x- and y-axes, measured in metres. Function prototype bool CExtAPI::map_SetHorizScale(ZMAP hMap, float scale); Arguments Name Type Comment hMap ZMAP A handle to a map, the horizontal scale of which is to be set. scale float The desired horizontal scaling, in metres. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:29:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_setminmaxalt&rev=1504164590&do=diff Description Set the stored minimum and maximum altitude of a map, in metres. This function only changes the values returned by map_GetMinMaxAlt, and does not change any height values in the map. Note this function fails for map types other than MAP_Heightfield and MAP_WaterMap. text/html 2017-08-31T07:21:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_setpixel&rev=1504164081&do=diff Description Set the value of a pixel in a map. Function prototype bool CExtAPI::map_SetPixel(ZMAP hMap, long x, long y, void* pValue); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the pixel of which is to be set. x long The x-coordinate of the pixel. y long The y-coordinate of the pixel. pValue void* A pointer (of unknown type) to the user-supplied entity that shall provide the pixel value. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:50:11+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_setwrapflag&rev=1504162211&do=diff Description Set the flag for whether the map is tiled such that the left/right and top/bottom edges wrap around to produce an infinitely repeating map. Note this function does not change the content of the map, and if the map does not already have matching borders, this function will not make them so. text/html 2017-08-31T05:48:34+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:map_splittomosaic&rev=1504158514&do=diff Description Convert an existing all-in-RAM map into a tiled mosaic map. Function prototype bool CExtAPI::map_SplitToMosaic(ZMAP hMap, const char* lpMosaicFileName, long TileSize, ZFORMAT hFormat, const char* lpProjMapName); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map variable that is to be split into a tiled mosaic map. lpMosaicFileName const char* A handle to a C-style string that contains the full path-name of the mosaic master file to be used by this map. Til… text/html 2017-08-31T04:37:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:menu_insertitem&rev=1504154255&do=diff menu_InsertItem2 Description Add an item to the menu in L3DT. Function prototype bool CExtAPI::menu_InsertItem(const char* lpFnName, const char* lpOptionName); Arguments Name Type Comment lpFnName const char* A pointer to a C-style string containing the name of the ZeoFunc to be activated by this menu option. lpOptionName const char* A pointer to a C-style string containing the display name of the menu option. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:54:23+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:menu_insertitem2&rev=1504155263&do=diff Description Add an item to the menu in L3DT. Function prototype bool CExtAPI::menu_InsertItem2(const char* lpFnName, const char* lpOptionName, unsigned long MenuContext, unsigned long Flags); Arguments Name Type Comment lpFnName const char* A pointer to a C-style string containing the name of the ZeoFunc to be activated by this menu option. lpOptionName const char* A pointer to a C-style string containing the display name of the menu option. MenuContext unsigned… text/html 2017-08-31T05:34:27+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:menu_insertitemex&rev=1504157667&do=diff menu_InsertItem2 Description Add an item to the menu in L3DT, which is optionally callable in its own thread. Function prototype bool CExtAPI::menu_InsertItemEx(const char* lpFnName, const char* lpOptionName, bool IsThreaded); Arguments Name Type Comment lpFnName const char* A pointer to a C-style string containing the name of the ZeoFunc to be activated by this menu option. lpOptionName const char* A pointer to a C-style string containing the display name of the menu option. IsTh… text/html 2017-08-31T05:58:47+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:progbox_hidewnd&rev=1504159127&do=diff Description Closes a progress-bar window. Function prototype bool CExtAPI::progbox_HideWnd(ZVAR hProgWnd); Arguments Name Type Comment hProgWnd ZVAR A ZVAR handle of type VarID_ProgBox. Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T04:20:47+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:progbox_setprogress&rev=1504153247&do=diff Description Set the current progress in a progress-bar window. Function prototype bool CExtAPI::progbox_SetProgress(ZVAR hProgWnd, __int64 p, __int64 pmax); Arguments Name Type Comment hProgWnd ZVAR A ZVAR handle of type VarID_ProgBox. p A signed 64-bit integer, representing the current progress. pmax A signed 64-bit integer, representing the maximum progress of the progress bar. Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T05:36:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:progbox_settitle&rev=1504157762&do=diff Description Set the title of a progress-bar window. Function prototype bool CExtAPI::progbox_SetTitle(ZVAR hProgWnd, const char* lpTitleText); Arguments Name Type Comment hProgWnd ZVAR A ZVAR handle of type VarID_ProgBox. lpTitleText const char* A pointer to a C-style string containing the new name of the progress window. Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T05:28:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:progbox_showwnd&rev=1504157329&do=diff Description Displays a progress-bar window. Function prototype bool CExtAPI::progbox_ShowWnd(ZVAR hProgWnd); Arguments Name Type Comment hProgWnd ZVAR A ZVAR handle of type VarID_ProgBox. Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T07:35:14+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:project_createmap&rev=1504164914&do=diff Description Create a new map layer in the application's project, and retrieve the handle. Function prototype ZMAP CExtAPI::project_CreateMap(const char* lpMapName); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name or mnemonic for the new map layer. Return value Null if an error occurred, and a valid non-null ZMAP handle otherwise. text/html 2017-08-31T06:31:03+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:project_getheightfieldrange&rev=1504161063&do=diff Description Get the minimum and maximum heights in the current project's heightfield, in units of metres. Function prototype bool CExtAPI::project_GetHeightfieldRange(float& minval, float& maxval); Arguments Name Type Comment minval float& A float for the minimum height (passed by reference). maxval float& A float for the maximum height (passed by reference). Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T07:19:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:project_getmap&rev=1504163944&do=diff Description Retrieve a handle to a map layer from the application's project. Function prototype ZMAP CExtAPI::project_GetMap(const char* lpMapName); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name of the map to be retrieved. See comments for legal values. Return value Null if an error occurred, and a valid non-null ZMAP handle otherwise. text/html 2017-08-31T06:43:48+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:project_getorcreatemap&rev=1504161828&do=diff Description Retrieve a handle to a map layer in the application's project. If the map layer is not found in the project, the map layer is created. Function prototype ZMAP CExtAPI::project_GetOrCreateMap(const char* lpMapName); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name of the map to be retrieved or created. Return value Null if an error occurred, and a valid non-null ZMAP handle otherwise. text/html 2017-08-31T04:44:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:project_getprojectfilename&rev=1504154670&do=diff Description Retrieve the filename of the current application project. Function prototype const char* CExtAPI::project_GetProjectFilename(void); Arguments None. Return value A handle to a C-style string containing the full path to the project filename, including drive, directory, filename and extension. If the project has not been saved, a null pointer is returned. text/html 2017-08-31T04:41:09+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:project_getsettingslist&rev=1504154469&do=diff Description Retrieve the settings list for the application project. Function prototype ZLIST CExtAPI::project_GetSettingsList(); Arguments None. Return value False if an error occurred, and true otherwise. Examples Exploring settings To view the settings in the project in a tree dialog, use the following code: text/html 2017-08-31T06:03:19+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:reporterror&rev=1504159399&do=diff Description Sends an error message to the parent application (e.g. L3DT). Function prototype void CExtAPI::ReportError(const char* lpErrorMessage); Arguments Name Type Comment lpErrorMessage const char* Pointer to a C-style string containing the error message. Return value None (void). text/html 2017-08-31T06:10:22+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:script_execute&rev=1504159822&do=diff Description Run a script string. Supported script languages currently include Python (via cdPython plugin) and ZeoScript (via ZeoScript plugin). Function prototype bool CExtAPI::script_Execute(const char* lpLangName, const char* lpScript, ZVAR hRval); text/html 2017-08-31T05:40:25+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:str_gettext&rev=1504158025&do=diff Description Retrieve the value of a string variable, as a C-style string. Function prototype const char* CExtAPI::str_GetText(ZVAR hStr); Arguments Name Type Comment hStr ZVAR A ZVAR handle to a string variable, the value of which is to be retrieved. Return value Null if an error occurred, and a valid C-string handle otherwise. text/html 2017-08-31T04:19:07+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:str_settext&rev=1504153147&do=diff Description Set the value of a string variable. Function prototype bool CExtAPI::str_SetText(ZVAR hStr, const char* lpText); Arguments Name Type Comment hStr ZVAR A ZVAR handle to a string, the value of which is to be set. lpText const char* The value to be set, as a C-style string. Return value False if an error occurs, and true otherwise. text/html 2017-08-31T05:46:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:tile_getdataptr&rev=1504158362&do=diff Description Retrieve the raw data pointer for a mosaic tile. Function prototype void* CExtAPI::tile_GetDataPtr(void* hTile); Arguments Name Type Comment hTile void* A handle to a mosaic tile. Return value A null pointer if: * The tile handle is invalid. * The tile has not been locked for use via tile_SetLock (this is automatic when loading/saving tiles). text/html 2017-08-31T04:29:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:tile_getminmaxalt&rev=1504153772&do=diff Description Get the minimum and maximum altitude within a mosaic tile (applies to the map types MAP_Heightfield and MAP_WaterMap only.) Function prototype bool CExtAPI::tile_GetMinMaxAlt(LPVOID hTile, float &minval, float &maxval); Arguments Name Type Comment hTile LPVOID A handle to a mosaic tile, the minimum and maximum altitude of which is to be retrieved. minval float& A float to receive the minimum altitude (passed by reference.) maxval float& A float to receive the maximum … text/html 2017-08-31T04:45:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:tile_getpixel&rev=1504154742&do=diff Description Get the value of a pixel in a mosaic tile. Function prototype bool CExtAPI::tile_GetPixel(LPVOID hTile, long x, long y, void* pValue); Arguments Name Type Comment hTile LPVOID A handle to a mosaic tile, a pixel of which is to be retrieved. x long The x-coordinate of the pixel within the tile. y long The y-coordinate of the pixel within the tile. pValue void* A pointer (of unknown type) to the user-supplied entity that shall receive the pixel value. Return value … text/html 2017-08-31T07:00:48+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:tile_gettilecoords&rev=1504162848&do=diff Description Get the x and y coordinates of of a tile in a mosaic. Function prototype bool CExtAPI::tile_GetTileCoords(LPVOID hTile, long &x, long &y); Arguments Name Type Comment hTile LPVOID A handle to a tile, the coordinates of which are to be retrieved. x long& A long integer to receive the x coordinate (passed by reference.) y long& A long integer to receive the y coordinate (passed by reference.) Return value False if an error occurred, and true otherwise (with x and y… text/html 2017-08-31T04:52:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:tile_setlock&rev=1504155124&do=diff Description Depending on the function arguments, this function: * Locks a mosaic tile in memory so that it will not be de-cached until the lock is released, or; * Releases the lock on a mosaic tile. Function prototype bool CExtAPI::tile_SetLock(void* hTile, bool LockState); text/html 2017-08-31T06:11:44+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:tile_setpixel&rev=1504159904&do=diff Description Set the value of a pixel in a mosaic tile. Function prototype bool CExtAPI::tile_SetPixel(LPVOID hTile, long x, long y, void* pValue); Arguments Name Type Comment hTile LPVOID A handle to a mosaic tile, a pixel of which is to be set. x long The x-coordinate of the pixel within the tile. y long The y-coordinate of the pixel within the tile. pValue void* A pointer (of unknown type) to the user-supplied entity that shall provide the pixel value. Return value False… text/html 2011-01-13T03:28:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:type_gettypeid&rev=1294889336&do=diff Description Get the variable type ID corresponding to a given variable type name. Function prototype long CExtAPI::type_GetTypeID(const char* lpTypeName); Arguments Name Type Comment lpTypeName const char* A pointer to a C-stlye string containing the name of the variable type for which the type ID is to be retrieved. Return value Zero if an error occurred or the type name is not recognised, and non-zero otherwise (can be positive or negative). text/html 2017-08-31T04:40:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:type_gettypename&rev=1504154428&do=diff Description Get the name of a variable type, as a string variable, corresponding to a given variable type ID. Function prototype bool CExtAPI::type_GetTypeName(long VarID, ZVAR hStringVar); Arguments Name Type Comment VarID long The variable type ID for which the corresponding name string is to be retrieved. hStringVar ZVAR A ZVAR handle to a user-supplied string variable (created with var_Create, var_CreateTemp or list_CreateItem.) Return value False if an error occurred or the… text/html 2017-08-31T04:57:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_copyvalue&rev=1504155450&do=diff Description Copy the value of one variable to another. Function prototype bool CExtAPI::var_CopyValue(ZVAR hVarDest, ZVAR hVarSrc); Arguments Name Type Comment hVarDest ZVAR A ZVAR handle to the destination variable, the value of which will be overwritten. vVarSrc ZVAR A ZVAR handle to the source variable, the value of which will overwrite the value of hVarDest. Return value False if: text/html 2017-08-31T05:43:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_create&rev=1504158193&do=diff Description Create a variable. Function prototype ZVAR CExtAPI::var_Create(long VarID, const char* lpVarName); Arguments Name Type Comment VarID long The type ID of the variable to be created. lpVarName const char* A pointer to a C-style string containing the name of the variable to be created (null if to be unnamed). Return value Null if an error occurred, and a non-NULL ZVAR handle otherwise. text/html 2017-08-31T05:32:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_createtemp&rev=1504157552&do=diff Description Create a temporary, unnamed variable. Function prototype ZVAR CExtAPI::var_CreateTemp(long VarID); Arguments Name Type Comment VarID long The type ID of the temporary variable to be created. Return value Null if an error occurred, and a non-null ZVAR handle otherwise. text/html 2017-08-31T05:36:29+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_delete&rev=1504157789&do=diff Description Delete a variable. Function prototype bool CExtAPI::var_Delete(ZVAR hVar); Arguments Name Type Comment hVar ZVAR A ZVAR handle to the variable to be deleted. Return value False if an error occurred, and true otherwise. Comments Once the variable has been deleted, the ZVAR handle becomes unassigned and cannot be used without first re-assigning it to another variable (e.g. using var_Create, var_GetVar, list_GetItemA, etc). Using an unassigned ZVAR is a sure way to get … text/html 2017-08-31T06:48:57+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_editui&rev=1504162137&do=diff Description Edit the value of a variable using L3DT's standard variable editing graphical user interface. Function prototype bool CExtAPI::var_EditUI(ZVAR hVar, const char* lpPrompt); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be edited. lpPrompt const char* A handle to a C-style string containing the title of the editor window. If null is given, a default title is used. Return value False if: text/html 2017-08-31T05:15:06+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_edituiex&rev=1504156506&do=diff Description Edit the value of a variable using L3DT’s standard variable editing graphical user interface. The var_EditUIEx function provides extended control over the user interface that is not available using the basic var_EditUI function. Function prototype bool CExtAPI::var_EditUIEx(ZVAR hVar, const char* lpPrompt, unsigned long Flags, ZLIST hOptions); text/html 2017-08-31T07:07:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_getdataptr&rev=1504163222&do=diff Description Retrieve the raw memory handle to the data contained within a ZVAR. Function prototype void* CExtAPI::var_GetDataPtr(ZVAR hVar); Arguments Name Type Comment hVar ZVAR The handle to variable for which the data pointer is to be retrieved. Return value A null pointer if: text/html 2017-08-31T04:22:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_getname&rev=1504153355&do=diff Description Retrieve the name of a variable. Function prototype const char* CExtAPI::var_GetName(ZVAR hVar); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the name of which is to be retrieved. Return value Null if an error occurred, and a non-null pointer to a C-style string otherwise. text/html 2017-08-31T04:48:46+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_gettypeid&rev=1504154926&do=diff Description Retrieve the type ID of a variable. Function prototype long CExtAPI::var_GetTypeID(ZVAR hVar); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the type of which is to be retrieved. Return value Zero if an error occurred or the variable is not initialised, and a non-zero variable type ID otherwise (can be positive or negative.) text/html 2017-08-31T05:50:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_getvalue&rev=1504158628&do=diff Description Retrieve the value of a variable. Function prototype bool CExtAPI::var_GetValue(ZVAR hVar, void* pValue); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be retrieved. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, ready to receive the value from the ZVAR. Return value False if: text/html 2017-08-31T07:11:14+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_getvaluea&rev=1504163474&do=diff Description Retrieve the value of a variable as a formatted text string. The 'A' in the function name 'var_GetValueA' refers to ASCII text. There is no Unicode or wide character equivalent function. Function prototype bool CExtAPI::var_GetValueA(ZVAR hVar, ZSTR hStrVar); text/html 2017-08-31T06:53:08+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_getvalueex&rev=1504162388&do=diff Description Retrieve the value of a variable, ensuring first it is of the correct variable type. Function prototype bool CExtAPI::var_GetValueEx(ZVAR hVar, long VarID, void* pValue); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be retrieved. VarID long The expected type ID of the variable. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, ready to receive the value from the ZVAR. Ret… text/html 2017-08-31T04:22:59+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_getvar&rev=1504153379&do=diff Description Retrieve the ZVAR handle of a named variable. Function prototype ZVAR CExtAPI::var_GetVar(const char* lpVarName); Arguments Name Type Comment lpVarName const char* A pointer to a C-style string naming the variable to be retrieved. Return value Null if an error occurred or the named variable does not exist, and a non-null ZVAR handle otherwise. text/html 2017-08-31T06:20:57+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_istype&rev=1504160457&do=diff Description Test whether a variable is initialised as a given type ID. Function prototype bool CExtAPI::var_IsType(ZVAR hVar, long VarID); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the type of which is to be tested. VarID long A long integer containing the variable type ID to be tested. Return value False if: text/html 2011-01-13T03:29:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_reinit&rev=1294889342&do=diff Description Re-initialise a variable as another type. Function prototype bool CExtAPI::var_ReInit(ZVAR hVar, long VarID); Arguments Name Type Comment hVar ZVAR A handle the the variable to be re-initialised. VarID long The new variable type ID. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:27:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_rename&rev=1504160870&do=diff Description Changes the name of a variable. Function prototype bool CExtAPI::var_Rename(ZVAR hVar, const char* lpNewName); Arguments Name Type Comment hVar ZVAR A ZVAR handle to the variable to be renamed. lpNewName const char* A pointer to a C-style string containing the new name of the variable. Return value False if: text/html 2017-08-31T05:55:40+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_setvalue&rev=1504158940&do=diff Description Set the value of a variable. Function prototype bool CExtAPI::var_SetValue(ZVAR hVar, void* pValue); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be set. pValue void* user-supplied handle to an allocated block of memory for the appropriate data type, containing the value to be set. Return value False if: text/html 2017-08-31T07:14:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_setvaluea&rev=1504163670&do=diff Description Set the value of a variable from an ASCII character string. Function prototype bool CExtAPI::var_SetValueA(ZVAR hVar, const char* lpValueText); Arguments Name Type Comment hVar ZVAR A ZVAR variable handle whose value is to be set. lpValueText const char* A handle to a C-style string containing the value (as text) to which the variable will be set. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:03:51+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_setvalueex&rev=1504163031&do=diff Description Set the value of a variable, ensuring first it is of the correct variable type. Function prototype bool CExtAPI::var_SetValueEx(ZVAR hVar, long VarID, void* pValue); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be set. VarID long The expected type ID of the variable. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, containing the value to be set. Return value False if: text/html 2017-08-31T05:43:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:var_setvarref&rev=1504158208&do=diff Description Set a variable to be a reference/alias of another variable. Function prototype bool CExtAPI::var_SetVarRef(ZVAR hPtrVar, ZVAR hSrcVar); Arguments Name Type Comment hPtrVar ZVAR A ZVAR handle to a variable, which will become the reference/alias of hSrcVar. hSrcVar ZVAR A ZVAR handle to a variable, which is to be referenced by hPtrVar. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:34:33+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:view_getactivemap&rev=1504154073&do=diff Description Retrieve a handle to the map currently displayed in the application window. Function prototype ZMAP CExtAPI::view_GetActiveMap(void); Arguments None. Return value A null handle if no map is displayed, and a valid non-null ZMAP handle otherwise. text/html 2017-08-31T06:09:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:view_getselectedarea2&rev=1504159770&do=diff Description Retrieve the selected area rectangle from L3DT's main map view. Function prototype bool CExtAPI::view_GetSelectedArea2(LPRECT lpRect); Arguments Name Type Comment lpRect LPRECT A handle to a RECT structure to receive the selected area coordinates. Return value False if no area is selected for the active map, and true otherwise (indicating success). text/html 2017-08-31T04:17:47+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:view_setselectedarea&rev=1504153067&do=diff Description Set the selected area rectangle in L3DT’s main map view. Function prototype bool CExtAPI::view_SetSelectedArea(const char* lpProjMapName, LPRECT lpRect); Arguments Name Type Comment lpProjMapName const char* A handle to a C-style string containing the name of the map layer whose area is to be selected. If null, the selection is cleared. lpRect LPRECT A handle to a RECT structure containing the bounding coordinates to be selected. Coordinates are included in the… text/html 2017-08-31T07:09:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:view_showmap&rev=1504163361&do=diff Description Set the map displayed in the main window of L3DT. Function prototype bool CExtAPI::view_ShowMap(const char* lpProjMapName); Arguments Name Type Comment lpProjMapName const char* A pointer to a C-style string that names the map to be displayed. Return value true, pretty much all the time. text/html 2017-08-31T07:11:54+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:writetolog&rev=1504163514&do=diff Description Write a message to L3DT's logfile. Unlike ReportError, this function does not write the message to the event log window. Thus, this function provides an unobtrusive method for plugins to log events for debugging purposes. Function prototype void CExtAPI::WriteToLog(const char* lpMessage); text/html 2017-08-31T06:36:05+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zapp_geticon&rev=1504161365&do=diff Description Get a handle to the application's icon as a Win32 HICON. Files Declaration helper/zApp.h Implementation helper/zApp.cpp Function prototype HICON zapp_GetIcon(); Return value Null if an error occurred, and a non-null HICON otherwise. text/html 2017-08-31T05:55:15+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zapp_gettempdir&rev=1504158915&do=diff Description Get the full path to the application's temporary directory. Files Declaration helper/zApp.h Implementation helper/zApp.cpp Function prototype bool zapp_GetTempDir(CzStr& TempDir); Arguments Name Type Comment TempDir CzStr& A CzStr object, passed by reference, that is to receive the path of the application's temporary directory. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:30:03+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zapp_getuid&rev=1504161003&do=diff Description Get a unique identifier (UID) from the application as a signed integer. Files Declaration helper/zApp.h Implementation helper/zApp.cpp Function prototype long zapp_GetUID(); Return value -1 if an error occurs, and otherwise a signed integer of value 0 or greater. text/html 2017-08-31T05:56:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbackup_nrecords&rev=1504158990&do=diff Description Count the number of backup/undo records in the undo stack. Files Declaration helper/zBackup.h Implementation helper/zBackup.cpp Function prototype long zbackup_nRecords(); Return value An integer containing the number of records in the undo stack. Errors return 0. text/html 2017-08-31T05:32:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_free&rev=1504157550&do=diff Description Release the memory allocated in a buffer (see zbuffer_Init or zbuffer_InitByType). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zbuffer_Free(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable, the memory of which is to be de-allocated. Return value False if the buffer is uninitialised or an error occurred, and true otherwise. text/html 2017-08-31T05:50:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_getptr&rev=1504158630&do=diff Description Get the raw pointer of a memory buffer. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void* zbuffer_GetPtr(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable from which the memory buffer pointer is to be retrieved. Return value Null if an error occurred or the buffer is uninitialised, and a valid non-null pointer otherwise. text/html 2017-08-31T05:51:07+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_getvalue&rev=1504158667&do=diff Description Retrieve the value of an item in a buffer. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zbuffer_GetValue(ZVAR hBuf, long index, void* pValue); Arguments Name Type Comment hBuf ZVAR A ZVAR handle to a buffer variable. index long The zero-based index of the item to be retrieved. pValue void* A pointer to the memory into which the value will be copied. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:49:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_init&rev=1504162189&do=diff Description Allocate memory in a buffer variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zbuffer_Init(ZVAR hBuf, long nItems, long ItemSize); Arguments Name Type Comment hBuf ZVAR A handle to the buffer variable to be initialised. nItems long The number of items for which memory is to be allocated. ItemSize long The size, in bytes, of the items in the buffer. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:54:34+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_initbytype&rev=1504162474&do=diff Description Allocate a static array of variable items in a buffer. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zbuffer_InitByType(ZVAR hBuf, long nItems, long ItemTypeID); Arguments Name Type Comment hBuf ZVAR A ZVAR handle to a variable of the VarID_buffer type. nItems long The number of items to allocate in the buffer. ItemTypeID long The variable type ID of the items in the buffer. Return value False if an error o… text/html 2017-08-31T07:24:22+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_itemsize&rev=1504164262&do=diff Description Retrieve the size, in bytes, of each item in a buffer (as set in zbuffer_Init or zbuffer_InitByType). To retrieve the combined size of all items in a buffer, use zbuffer_MemSize. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zbuffer_ItemSize(ZVAR hBuffer); text/html 2017-08-31T04:16:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_memsize&rev=1504152981&do=diff Description Determine the total number of bytes allocated in the buffer. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zbuffer_MemSize(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable, from which the total memory allocation (in bytes) is to be determined. Return value A positive integer representing the total number of bytes allocated in the buffer, or zero if the buffer is uninitialised or an error occurred… text/html 2017-08-31T07:20:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_nitems&rev=1504164000&do=diff Description Retrieve the number of items allocated in a buffer, as set by zbuffer_Init or zbuffer_InitByType. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zbuffer_nItems(ZVAR hBuffer); Arguments Name Type Comment hBuffer ZVAR A handle to a buffer variable, from which the number of items contained are to be determined. Return value Zero if the buffer is uninitialised or an error occurred, and otherwise a positive integer representing the number… text/html 2017-08-31T05:21:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zbuffer_setvalue&rev=1504156896&do=diff Description Set the value of an item in a buffer. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zbuffer_SetValue(ZVAR hBuf, long index, void* pValue); Arguments Name Type Comment hBuf ZVAR A ZVAR handle to a buffer variable. index long The zero-based index of the item to be set. pValue void* A pointer to the value to be copied. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:18:17+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zcombosel_noptions&rev=1504160297&do=diff Description Count the number of options in a combination selector variable (variable type: VarID_combosel). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zcombosel_nOptions(ZVAR hComboSel); Arguments Name Type Comment hComboSel ZVAR A ZVAR handle to a combination selector variable, the number of options in which are to be counted. Return value An integer containing the number of options in the combination selector variable. Errors r… text/html 2017-08-31T05:43:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zdirsel_getpatha&rev=1504158230&do=diff Description Retrieve the selected directory name from a directory selector variable (VarID_dirsel). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zdirsel_GetPathA(ZVAR hDirSel, ZSTR hReturnStr); Arguments Name Type Comment hDirSel ZVAR A ZVAR handle to a VarID_dirsel variable, the selected directory name of which is to be retrieved. hReturnStr ZSTR A ZSTR handle to a string variable that is to receive the full path to the selecte… text/html 2017-08-31T06:16:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zdirsel_init&rev=1504160192&do=diff Description Initialise the contents of a directory selector variable (VarID_dirsel). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zdirsel_Init(ZVAR hDirSel, const char* lpStartDir); Arguments Name Type Comment hDirSel ZVAR A ZVAR handle to a variable, which must be of type VarID_dirsel. lpStartDir const char* A handle to a C-style string containing the initial directory of the directory selector variable. The directory name must… text/html 2017-08-31T06:28:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeofunc_execute2&rev=1504160884&do=diff Description Execute a Zeolite extension function and retrieve the return value. Function prototype bool CExtAPI::zeofunc_Execute2(ZFUNC hFunc, ZLIST hArgList, ZVAR* phRval); Arguments Name Type Comment hFunc ZFUNC A handle to the extension function to be executed. hArgList ZLIST A handle to the argument list to be passed to the function. phRval ZVAR* A handle to a caller-provided, initialised variable handle to contain the return value. Return value False if an error occurred… text/html 2017-08-31T07:27:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeofunc_executethreaded&rev=1504164469&do=diff Description Execute a Zeolite extension function in a new worker thread. Function prototype bool CExtAPI::zeofunc_ExecuteThreaded(ZFUNC hFunc, ZLIST hArgList, bool DeleteArgs, long ThreadPriority); Arguments Name Type Comment hFunc ZFUNC A handle to the extension function to be executed. hArgList ZLIST A handle to the argument list to be passed to the function. DeleteArgs bool A flag stating whether or not the function should delete its arguments once it has completed. ThreadPr… text/html 2017-08-31T04:46:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeofunc_getarglistprototype&rev=1504154796&do=diff Description Retrieve a prototype list of arguments for a function. Function prototype bool CExtAPI::zeofunc_GetArgListPrototype(ZFUNC hFunc, ZLIST hArgList); Arguments Name Type Comment hFunc ZFUNC A ZVAR handle to function variable, the argument list prototype of which is to be retrieved. hArgList ZLIST A ZVAR handle to a list variable that shall receive the argument list. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:20:39+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeofunc_getfunc&rev=1504164039&do=diff Description Retrieve a handle to a Zeolite extension function. Function prototype ZFUNC CExtAPI::zeofunc_GetFunc(const char* lpFuncName); Arguments Name Type Comment lpFuncName const char* A handle to a C-style string containing the full name of the function (including namespace, delimited by '.' dot operator.) See link in comments for examples. Return value A null handle if the function is not found or an error occurred, and a valid non-null handle otherwise. text/html 2017-08-31T04:27:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeofunc_getreturntypeid&rev=1504153656&do=diff Description Retrieve the variable type ID of the return value of a Zeolite extension function. Function prototype long CExtAPI::zeofunc_GetReturnTypeID(ZFUNC hFunc); Arguments Name Type Comment hFunc ZFUNC A handle to a Zeolite extension function, the return type of which is to be retrieved. Return value Zero if an error occurred, and a valid non-zero (positive or negative) return type ID otherwise. The name of the return type, as a string, may be retrieved using the type_GetTypeNa… text/html 2017-08-31T06:51:58+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeofunc_loadfunc&rev=1504162318&do=diff Description Load a Zeolite extension function from a plugin. Function prototype ZFUNC CExtAPI::zeofunc_LoadFunc(const char* lpFnName, long rvalVarID, ZLIST hArgListPrototype); Arguments Name Type Comment lpFnName const char* A handle to a C-style string containing the name of the function as it appears in the plugin exports table. rvalVarID long The variable type ID of the return variable when the function is called. May be VarID_void if no var is returned. hArgListPrototype ZLIS… text/html 2017-08-31T07:20:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeofunc_loadfuncex&rev=1504164000&do=diff Description Load a Zeolite extension function from a plugin. Function prototype bool CExtAPI::zeofunc_LoadFuncEx(const char* lpFnName, const char* lpExportName, long rvalVarID, ZLIST hArgList); Arguments Name Type Comment lpFnName const char* A handle to a C-style string containing the name of the function as is to appear in the Zeolite function list. lpFnName const char* A handle to a C-style string containing the name of the function as it appears in the plugin exports table. rv… text/html 2017-08-31T06:24:45+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeoreporterror&rev=1504160685&do=diff Description Sends an error message to the parent application (e.g. L3DT). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void zeoReporteEror(const char* lpErrorMessage); Arguments Name Type Comment lpErrorMessage const char* Pointer to a C-style string containing the error message. Return value None (void). text/html 2017-08-31T04:30:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zeowritetolog&rev=1504153842&do=diff Description Write a message to L3DT's logfile. Unlike zeoReportError, this function does not write the message to the event log window. Thus, this function provides an unobtrusive method for plugins to log events for debugging purposes. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void zeoWriteToLog(const char* lpMessage); text/html 2017-08-31T04:31:51+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfile_createdir&rev=1504153911&do=diff Description Create a directory on disk. Files Declaration zFile.h Implementation zFile.cpp Function prototype bool zfile_CreateDir(const char* lpDirName); Arguments Name Type Comment lpDirName const char* A pointer to a C-style string containing the full path of the directory to be created. Return value True if the directory was successfully created or already existed, and false otherwise. text/html 2017-08-31T07:20:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfile_direxists&rev=1504164028&do=diff Description Test whether a directory exists. Files Declaration zFile.h Implementation zFile.cpp Function prototype bool zfile_DirExists(const char* lpDirName); Arguments Name Type Comment lpDirName const char* A pointer to a C-style string containing the full path name of the directory whose existence is to be tested. Return value True if a directory exists at lpDirName, and false otherwise. text/html 2017-08-31T05:01:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfile_fileexists&rev=1504155709&do=diff Description Test whether a file exists. Files Declaration zFile.h Implementation zFile.cpp Function prototype bool zfile_FileExists(const char* lpFileName); Arguments Name Type Comment lpFileName const char* A pointer to a C-style string containing the full path name of the file whose existence is to be tested. Return value True if the file is found at lpFileName, and false otherwise. text/html 2017-08-31T07:04:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfile_getdir&rev=1504163042&do=diff Description Get the full path to the directory containing the specified file. Files Declaration zFile.h Implementation zFile.cpp Function prototype bool zfile_GetDir(const char* lpPathName, ZSTR hResult); Arguments Name Type Comment lpPathName const char* A handle to a C-style string containing the file name, the directory of which is to be determined. hResult ZSTR A ZSTR handle to a string variable that is to receive the directory string. Return value False … text/html 2017-08-31T06:05:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfile_getext&rev=1504159528&do=diff Description Get the file extension of a file name. Files Declaration zFile.h Implementation zFile.cpp Function prototype bool zfile_GetExt(const char* lpFileName, ZSTR hResult); Arguments Name Type Comment lpFileName const char* A handle to a C-style string containing the file name, the extension of which is to be determined. hResult ZSTR A ZSTR handle to a string variable that is to receive the extension string. Return value False if no extension was found … text/html 2017-08-31T07:33:39+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfile_trimdir&rev=1504164819&do=diff Description Trim the directory path from a given file name. Files Declaration zFile.h Implementation zFile.cpp Function prototype bool zfile_TrimDir(const char* lpFileName, ZSTR hResult); Arguments Name Type Comment lpFileName const char* A pointer to a C-style string containing a file name, the directory of which is to be trimmed off. hResult ZSTR A ZSTR handle to a string variable that is to receive the file name with the extension trimmed off. Return value … text/html 2017-08-31T07:14:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfile_trimext&rev=1504163661&do=diff Description Trim the file extension from a given file name. Files Declaration zFile.h Implementation zFile.cpp Function prototype bool zfile_TrimExt(const char* lpFileName, ZSTR hResult); Arguments Name Type Comment lpFileName const char* A pointer to a C-style string containing a file name, the extension of which is to be trimmed off. hResult ZSTR A ZSTR handle to a string variable that is to receive the file name with the extension trimmed off. Return value … text/html 2017-08-31T06:13:46+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfilesel_getpatha&rev=1504160026&do=diff Description Retrieve the selected file name from a file selector variable (VarID_filesel). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zfilesel_GetPathA(ZVAR hFileSel, ZSTR hReturnStr); Arguments Name Type Comment hFileSel ZVAR A ZVAR handle to a VarID_filesel variable, the selected file name of which is to be retrieved. hReturnStr ZSTR A ZSTR handle to a string variable that is to receive the file name of the file selector vari… text/html 2017-08-31T07:08:55+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfilesel_init&rev=1504163335&do=diff Description Initialise the contents of a file selector variable (VarID_filesel). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zfilesel_Init(ZVAR hFileSel, bool OpenFileFlag, const char* lpFileName, const char* lpFilterStr, const char* lpDefaultExt, const char* lpDefaultDir); text/html 2017-08-31T04:16:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zformat_create&rev=1504152995&do=diff Description Create an instance of a file format handler for a particular project map. This function, or zformat_CreateGeneric, must be called at least once by a file input/output plugin before it can be used to save or load map files. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZFORMAT zformat_Create(const char* lpMapName, const char* lpLongName, const char* lpFileExt, const char* lpNativeProgramName); text/html 2017-08-31T05:11:01+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zformat_creategeneric&rev=1504156261&do=diff Description Create an instance of a file format handler for a particular map type. This function, or zformat_Create, must be called at least once by a file input/output plugin to register a file format before it can be used to save or load map files. text/html 2017-08-31T06:46:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zformat_getext&rev=1504161981&do=diff Description Get the file extension of a ZFORMAT variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype const char* zformat_GetExt(ZFORMAT hFormat); Arguments Name Type Comment hFormat ZFORMAT A ZFORMAT handle, the file extension of which is to be retrieved. Return value Null if an error occurred, or otherwise a pointer to a C-style string containing the file extension of the given format. text/html 2017-08-31T07:20:55+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zformat_getflags&rev=1504164055&do=diff Description Retrieve the support flags for a file format handler variable (VarID_format). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype unsigned long zformat_GetFlags(ZFORMAT hFormat); Arguments Name Type Comment hFormat ZFORMAT A ZFORMAT handle to a file format, the support flags of which are to be retrieved. . Return value An unsigned long integer representing a bitfield combination of file format flags. Please refer to the zformat_Set… text/html 2017-08-31T06:21:24+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zformat_setflags&rev=1504160484&do=diff Description Set the file format support flags for a file format handler variable (VarID_format). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zformat_SetFlags(ZFORMAT hFormat, unsigned long Flags); Arguments Name Type Comment hFormat ZFORMAT A 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 f… text/html 2017-08-31T05:29:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfunc_execute&rev=1504157375&do=diff Description Execute a Zeolite extension function and retrieve the return value. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zfunc_Execute(ZFUNC hFunc, ZLIST hArgList, ZVAR* phRval); Arguments Name Type Comment hFunc ZFUNC A handle to the extension function to be executed. hArgList ZLIST A handle to the argument list to be passed to the function. phRval ZVAR* A handle to a caller-provided, initialised variable handle to contain the return v… text/html 2017-08-31T07:35:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfunc_getarglistprototype&rev=1504164931&do=diff Description Retrieve a prototype list of arguments for a function. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zfunc_GetArgListPrototype(ZFUNC hFunc, ZLIST hArgList); Arguments Name Type Comment hFunc ZFUNC A ZVAR handle to function variable, the argument list prototype of which is to be retrieved. hArgList ZLIST A ZVAR handle to a list variable that shall receive the argument list. Return value False if an error occurred, and true other… text/html 2017-08-31T05:47:05+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfunc_getfunc&rev=1504158425&do=diff Description Retrieve a handle to a Zeolite extension function. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZFUNC zfunc_GetFunc(const char* lpFuncName); Arguments Name Type Comment lpFuncName const char* A handle to a C-style string containing the full name of the function (including namespace, delimited by '.' dot operator.) See link in comments for examples. Return value A null handle if the function is not found or an error occurred, and a valid… text/html 2017-08-31T07:18:52+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfunc_getreturntypeid&rev=1504163932&do=diff Description Retrieve the variable type ID of the return value of a Zeolite extension function. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zfunc_GetReturnTypeID(ZFUNC hFunc); Arguments Name Type Comment hFunc ZFUNC A handle to a Zeolite extension function, the return type of which is to be retrieved. Return value Zero if an error occurred, and a valid non-zero (positive or negative) return type ID otherwise. The name of the return type, as a … text/html 2017-08-31T07:35:12+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zfunc_load&rev=1504164912&do=diff Description Load a Zeolite extension function from a plugin. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype TYPE zfunc_Load(const char* lpFnName, const char* lpExportName, long rvalVarID, ZLIST hArgList); Arguments Name Type Comment lpFnName const char* A handle to a C-style string containing the name of the function as is to appear in the Zeolite function list. Use the '.' (dot) character to delimit namespaces. lpFnName const char* A handle to a C-s… text/html 2017-08-31T07:12:33+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_append&rev=1504163553&do=diff Description Append the contents of one list to the end of another. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zlist_Append(ZLIST hList, ZLIST hList2); Arguments Name Type Comment hList ZLIST A handle to a list. hList2 ZLIST A handle to a second list, the contents of which are to be appended to the first list (hList). Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:56:52+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_createitem&rev=1504155412&do=diff Description Create a variable in a list. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZVAR zlist_CreateItem(ZLIST hList, long VarID, const char* lpVarName); Arguments Name Type Comment hList ZLIST A ZLIST handle, to which an item will be added. VarID long The VarID of the new item. lpVarName const char* The name of the new item. If null, the variable is unnamed. Return value Null if an error occurred, and a valid ZVAR handle otherwise. text/html 2017-08-31T05:17:07+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_delall&rev=1504156627&do=diff Description Delete all items in a list. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zlist_DelAll(ZLIST hList); Arguments Name Type Comment hList ZLIST A ZLIST handle, all the items of which are to be deleted. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:00:07+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_delitema&rev=1504162807&do=diff Description Delete an item from a list, specified by its name. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zlist_DelItemA(ZLIST hList, const char* lpVarName); Arguments Name Type Comment hList ZLIST A ZLIST handle, an item of which is to be deleted. lpVarName const char* A pointer to a C-style string, giving the name of the variable to be deleted. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:18:44+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_delitemi&rev=1504156724&do=diff Description Delete an item from a list, specified by its index in the list. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zlist_DelItemI(ZLIST hList, long index); Arguments Name Type Comment hList ZLIST A ZLIST handle, an item of which is to be deleted. index long The zero-based index of the variable to be deleted. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:59:58+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_getitema&rev=1504162798&do=diff Description Retrieve a ZVAR handle to an item in a list, specified by its name. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZVAR zlist_GetItemA(ZLIST hList, const char* lpVarName); Arguments Name Type Comment hList ZLIST A ZLIST handle, an item of which is to be retrieved. lpVarName const char* A pointer to a C-style string, giving the name of the variable to be retrieved. Return value Null if an error occurred, and a valid ZVAR otherwise. text/html 2017-08-31T06:30:38+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_getitemi&rev=1504161038&do=diff Description Retrieve a ZVAR handle to an item in a list, specified by its index in the list. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZVAR zlist_GetItemI(ZLIST hList, long index); Arguments Name Type Comment hList ZLIST A ZLIST handle, an item of which is to be retrieved. index long The index of the item to be retrieved. Indices are zero-based (C-style). Return value Null if an error occurred, and a valid ZVAR otherwise. text/html 2017-08-31T05:31:44+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_nitems&rev=1504157504&do=diff Description Count the number of items in a list. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zlist_nItems(ZLIST hList); Arguments Name Type Comment hList ZLIST A ZLIST handle, the number of items in which are to be counted. Return value The number of items in the list. Zero is returned in the case of an error. text/html 2017-08-31T04:59:12+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_sorta&rev=1504155552&do=diff Description Sort an item in a list to another index. In zlist_SortA, the item to be sorted is specified by its name (compare: zlist_SortI). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zlist_SortA(ZLIST hList, const char* lpItemName, long To); text/html 2017-08-31T04:15:14+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zlist_sorti&rev=1504152914&do=diff Description Sort an item in a list to another index. In zlist_SortI, the item to be sorted is specified by its current location (compare: zlist_SortA). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zlist_SortI(ZLIST hList, long From, long To); text/html 2017-08-31T07:20:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_clearmipmaps&rev=1504164042&do=diff Description Clear and de-allocate the mipmaps for a map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_ClearMipmaps(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A handle to a map variable, the mipmaps of which are to be cleared. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:33:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_combinemosaic&rev=1504157611&do=diff Description Combine a mosaic map into an un-tiled 'all-in-RAM' map, with a map allocation mode of MAPALLOC_RAM (see zmap_GetAllocMode). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_CombineMosaic(ZMAP hMap); text/html 2017-08-31T05:55:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_exportmap&rev=1504158921&do=diff Description Export a map as a file, optionally with a different map size. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_ExportMap(ZMAP hMap, const char* lpFileName, ZFORMAT hFormat, long nx, long ny); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map to be exported. lpFileName const char* A C-style string containing the name of the output file. hFormat ZFORMAT A ZFORMAT handle to the format to be used to s… text/html 2017-08-31T04:41:23+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_exportmosaic&rev=1504154483&do=diff Description Export a mosaic map, and all its tiles, to a different file name/path. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_ExportMosaic(ZMAP hMap, const char* lpFileName, ZFORMAT hFormat, long nx, long ny, long TileSize, const char* lpProjMapName); text/html 2017-08-31T06:25:40+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_free&rev=1504160740&do=diff Description De-allocate a map, release memory, etc. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_Free(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map that is to be freed. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:11:57+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_genmipmaps&rev=1504163517&do=diff Description Generate the multi-resolution mipmaps for a given map. These mipmaps are smaller, sub-sampled versions used in level-of-detail algorithms such as texture rendering in Sapphire. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_GenMipMaps(ZMAP hMap, long ResStep, long MaxLevel, long TileSize); text/html 2017-08-31T04:21:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getallocmode&rev=1504153295&do=diff Description Retrieve the memory allocation mode for a map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype unsigned long zmap_GetAllocMode(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable. Return value The following return values are defined in Zeolite_defines.h: text/html 2017-08-31T04:52:34+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getbusyflag&rev=1504155154&do=diff Description Retrieve the busy flag for a map. Please see zmap_SetBusyFlag for the meaning of this flag. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_GetBusyFlag(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the busy flag of which is to be retrieved. Return value True if: text/html 2013-08-22T00:20:48+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getdataptr&rev=1377130848&do=diff Description Retrieve the raw handle to map memory. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void* zmap_GetDataPtr(ZMAP hMap); Arguments Name Type Comment hMap ZMAP The ZMAP handle of the map for which the data handle is to be retrieved. Return value A null pointer if: text/html 2017-08-31T06:43:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getfilename&rev=1504161822&do=diff Description Retrieve the full pathname of the file in which a given map has been saved (for example, C:\My maps\map1.hff). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype const char* zmap_GetFilename(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the saved filename of which is to be retrieved. Return value A null pointer if the map has not yet been saved or an error occurred, and otherwise a valid non-null… text/html 2017-08-31T04:17:18+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getflag&rev=1504153038&do=diff Description Retrieve the state of a flag for a map. See zmap_SetFlag for the list of supported flags, and their meanings. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_GetFlag(ZMAP hMap, long FlagID); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, a flag of which is to be retrieved. FlagID long The ID of the flag to be retrieved. See zmap_SetFlag for allowed values. Return value True if the flag exists, and … text/html 2017-08-31T07:14:03+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getformat&rev=1504163643&do=diff Description Retrieve the file format used to save a given map to disk. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZFORMAT zmap_GetFormat(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the saved file format of which is to be retrieved. Return value A null handle if the map has not been saved or an error occurred, and a valid non-null ZFORMAT handle otherwise. text/html 2017-08-31T07:21:15+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getheight&rev=1504164075&do=diff Description Get the number of pixels in the y-axis of the map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_GetHeight(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the height of which is to be retrieved. Return value Zero if an error occurred or the map is uninitialised, and non-zero otherwise. text/html 2017-08-31T05:32:14+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_gethorizscale&rev=1504157534&do=diff Description Get the distance between neighbouring pixels in a map in the x- and y-axes, measured in metres. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype float zmap_GetHorizScale(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, the horizontal scaling of which is to be retrieved. Return value Zero if an error occurred, and greater than zero otherwise. text/html 2017-08-31T06:47:27+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getmaptype&rev=1504162047&do=diff Description Retrieve the map type identifier of a given map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_GetMapType(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the type of which is to be retrieved. Return value Zero if an error occurred, or the map was uninitialised. Otherwise, a non-zero (positive or negative) value is returned. Please consult the map type page or 'Zeolite_defines.h' for a list of… text/html 2017-08-31T05:23:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getminmaxalt&rev=1504157036&do=diff Description Get the minimum and maximum altitude of a map, in metres. Note this function fails for map types other than MAP_Heightfield and MAP_WaterMap. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_GetMinMaxAlt(ZMAP hMap, float& minval, float& maxval); text/html 2017-08-31T04:14:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getmipmaplevel&rev=1504152872&do=diff Description Get a mipmap (as a ZMAP handle) for a given map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZMAP zmap_GetMipmapLevel(ZMAP hMap, long MipLevel); Arguments Name Type Comment hMap ZMAP A handle to a map variable, a mipmap of which is to be retrieved. MipLevel long The sub-sampling factor of the desired mipmap. See comments below. Return value A null pointer if the desired mipmap does not exist, or if an error occurred. O… text/html 2017-08-31T04:40:58+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getmipmapmaxlevel&rev=1504154458&do=diff Description Get the maximum mipmap level for a given map. This function is used for bounds checking in calls to zmap_GetMipmapLevel. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_GetMipmapMaxLevel(ZMAP hMap); text/html 2017-08-31T05:29:38+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getmipmapresstep&rev=1504157378&do=diff Description Get the resolution step factor between successive mipmaps for a given map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_GetMipmapResStep(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A handle to a map variable, the mipmap resolution step factor of which is to be retrieved. Return value An integer greater than one if mipmaps have been initialised. Otherwise, zero is returned. text/html 2017-08-31T04:56:24+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getmosaicflag&rev=1504155384&do=diff Description Get the mosaic flag for a map, which states whether it is tiled or not. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_GetMosaicFlag(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, the mosaic flag of which is to be retrieved. Return value True if: text/html 2017-08-31T05:53:37+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getmosaictile&rev=1504158817&do=diff Description Retrieve a handle to a tile in a mosaic map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void* zmap_GetMosaicTile(ZMAP hMap, long tx, long ty); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, a tile of which is to be retrieved. tx long The x-coordinate of the tile. ty long The y-coordinate of the tile. Return value A null handle if: text/html 2017-08-31T06:03:47+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getnameinproject&rev=1504159427&do=diff Description Retrieve the name of a map as it appears in the project's map list. This is the name used in the zproj_GetMap and zview_ShowMap functions, amongst others. The name is set in the zproj_CreateMap function, and cannot be changed thereafter. text/html 2017-08-31T07:29:45+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getpixel&rev=1504164585&do=diff Description Get the value of a pixel in a map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_GetPixel(ZMAP hMap, long x, long y, void* pValue); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the pixel of which is to be retrieved. x long The x-coordinate of the pixel. y long The y-coordinate of the pixel. pValue void* A pointer (of unknown type) to the user-supplied entity that shall receive the pi… text/html 2017-08-31T04:37:53+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getpixelsize&rev=1504154273&do=diff Description Get the size in memory of a pixel in the map, measured in bytes. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_GetPixelSize(ZMAP hMap); Arguments Name Type Comment hMap ZMAP The ZMAP handle to a map, the pixel size of which is to be retrieved. Return value Zero if an error occurred or the map is not initialised, and non-zero otherwise. text/html 2017-08-31T04:26:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getscanlinearray&rev=1504153560&do=diff Description Get the pointer to the array of scanlines of a map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void** zmap_GetScanlineArray(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map. Return value A null pointer if: text/html 2017-08-31T06:54:54+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getscanlineptr&rev=1504162494&do=diff Description Get the pointer to the first pixel of a scanline in a map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void* zmap_GetScanlinePtr(ZMAP hMap, long j); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map. j long The y-axis coordinate of the scanline. Note the origin is at the southwest corner of the map. Return value A null pointer if: text/html 2017-08-31T06:13:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getsettingslist&rev=1504160011&do=diff Description Retrieve the list of settings for this map. This list is usually empty, but may contain flags, georeferencing data, or other data set by plugins. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZLIST zmap_GetSettingsList(ZMAP hMap); text/html 2017-08-31T04:40:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_gettilecountx&rev=1504154432&do=diff Description Get the number of tiles in the x-axis in a tiled (mosaic) map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_GetTileCountX(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, for which the mosaic tile count in the x-axis is to be retrieved. Return value Zero if an error occurred or the map is not a mosaic, and greater than zero otherwise. text/html 2017-08-31T06:49:16+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_gettilecounty&rev=1504162156&do=diff Description Get the number of tiles in the y-axis in a tiled (mosaic) map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_GetTileCountY(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map, for which the mosaic tile count in the y-axis is to be retrieved. Return value Zero if an error occurred or the map is not a mosaic, and greater than zero otherwise. text/html 2017-08-31T07:06:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_gettilesize&rev=1504163181&do=diff Description Get the size, in pixels, of the side-length of the tiles in a tiled (mosaic) map. Note tiles are always square, even though maps are not. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_GetTileSize(ZMAP hMap); text/html 2017-08-31T06:37:45+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getwidth&rev=1504161465&do=diff Description Get the number of pixels in the x-axis of the map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_GetWidth(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the width of which is to be retrieved. Return value Zero if an error occurred or the map is uninitialised, and non-zero otherwise. text/html 2017-08-31T04:50:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_getwrapflag&rev=1504155000&do=diff Description Get the flag for whether the map is tiled such that the left/right and top/bottom edges wrap around to produce an infinitely repeating map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_GetWrapFlag(ZMAP hMap); text/html 2017-08-31T06:04:46+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_init&rev=1504159486&do=diff Description Initialise a map and allocate required memory. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_Init(ZMAP hMap, long nx, long ny, long MapTypeID, float HorizScale, bool WrapFlag); Arguments Name Type Comment hMap ZMAP a ZMAP handle to a map variable. nx long The number of pixels in the x-direction (width). ny long The number of pixels in the y-direction (height). MapTypeID long The integer identifier fo… text/html 2017-08-31T04:31:39+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_initmosaic&rev=1504153899&do=diff Description Initialise a map as a tiled mosaic. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_InitMosaic(ZMAP hMap, long nx, long ny, long MapTypeID, float HorizScale, bool WrapFlag, const char* lpMosaicFileName, long TileSize, ZFORMAT hFormat, const char* lpProjMapName); text/html 2017-08-31T06:04:11+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_iscontiguous&rev=1504159451&do=diff Description Determine whether a map has been allocated in memory as a single, contiguous block of RAM. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_IsContiguous(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map. Return value True if the map is initialised, not a mosaic, and allocated as a contiguous block of memory. False otherwise. text/html 2017-08-31T06:37:26+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_lininterp&rev=1504161446&do=diff Description Calculate the value of a point in the map via linear interpolation of the nearest pixels. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_LinInterp(ZMAP hMap, double dx, double dy, void* pValue); text/html 2017-08-31T07:30:33+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_loadfile&rev=1504164633&do=diff Description Load a map from a file. Note: this does not work for mosaics. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_LoadFile(ZMAP hMap, const char* lpFileName, long MapTypeID, ZFORMAT hFormat, bool SetFlags, bool ShowProgress); text/html 2017-08-31T05:15:36+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_loadmosaic&rev=1504156536&do=diff Description Load a mosaic map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_LoadMosaic(ZMAP hMap, const char* lpMosaicFileName); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map that shall be loaded from disk. lpMosaicFileName const char* A handle to a C-style string containing the full path-name of the mosaic master file to be loaded. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:26:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_nmipmaps&rev=1504157164&do=diff Description Query the number of mipmap layers allocated for a map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zmap_nMipmaps(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map. Return value The number of mipmap layers allocated for the given map, or 0 if an error was encountered. text/html 2017-08-31T04:47:41+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_savefile&rev=1504154861&do=diff Description Save a map as a single map file (non-mosaic.) Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SaveFile(ZMAP hMap, const char* lpFileName, ZFORMAT hFormat, bool SetFlags, bool ShowProgress); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map variable, the contents of which are to be saved to disk. lpFileName const char* A handle to a C-style string containing the full path and extension of the file to be saved. hFormat … text/html 2017-08-31T04:18:48+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_savemosaic&rev=1504153128&do=diff Description Save all tiles in a mosaic map to disk (closes RAM cache). Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SaveMosaic(ZMAP hMap); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the map that is to be saved. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:18:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_savemosaicas&rev=1504160282&do=diff Description Re-save a mosaic, and all its tiles, with a new name/path. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SaveMosaicAs(ZMAP hMap, const char* lpFileName); Arguments Name Type Comment hMap ZMAP A ZMAP handle to the mosaic map to be re-saved. lpFileName const char* A pointer to a C-style string containing the full path an extension of the new mosaic master file. Return value False if an error occurred, and true o… text/html 2017-08-31T04:20:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_setbusyflag&rev=1504153228&do=diff Description Mark a map to be 'busy', typically meaning the map is in use by a calculation. Maps that are marked busy cannot be deallocated by zmap_Free. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SetBusyFlag(ZMAP hMap, bool BusyFlag); text/html 2017-08-31T06:52:51+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_setflag&rev=1504162371&do=diff Description Set the value of a flag for a map (see , below.) Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SetFlag(ZMAP hMap, long FlagID, bool FlagValue); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, a flag of which is to be set. FlagID long The ID of the flag to be set. See below for allowed values. FlagValue bool The boolean value of the flag to be set. Return value False if: text/html 2017-08-31T06:25:47+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_setformat&rev=1504160747&do=diff Description Change the file format used to save a map to disk. This function will re-save the map in the new format, and change the file extension if necessary. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SetFormat(ZMAP hMap, ZFORMAT hFormat); text/html 2017-08-31T06:43:39+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_sethorizscale&rev=1504161819&do=diff Description Set the distance between neighbouring pixels in a map in the x- and y-axes, measured in metres. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SetHorizScale(ZMAP hMap, float scale); Arguments Name Type Comment hMap ZMAP A handle to a map, the horizontal scale of which is to be set. scale float The desired horizontal scaling, in metres. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:22:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_setminmaxalt&rev=1504156933&do=diff Description Set the stored minimum and maximum altitude of a map, in metres. This function only changes the values returned by zmap_GetMinMaxAlt, and does not change any height values in the map. Note this function fails for map types other than MAP_Heightfield and MAP_WaterMap. text/html 2017-08-31T05:16:51+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_setpixel&rev=1504156611&do=diff Description Set the value of a pixel in a map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SetPixel(ZMAP hMap, long x, long y, void* pValue); Arguments Name Type Comment hMap ZMAP A ZMAP handle to a map, the pixel of which is to be set. x long The x-coordinate of the pixel. y long The y-coordinate of the pixel. pValue void* A pointer (of unknown type) to the user-supplied entity that shall provide the pixel value.… text/html 2017-08-31T04:15:09+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_setwrapflag&rev=1504152909&do=diff Description Set the flag for whether the map is tiled such that the left/right and top/bottom edges wrap around to produce an infinitely repeating map. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_SetWrapFlag(ZMAP hMap, bool WrapFlag); text/html 2017-08-31T07:11:40+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_tile_getdataptr&rev=1504163500&do=diff Description Retrieve the raw memory pointer to the data block of a mosaic tile. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void* zmap_tile_GetDataPtr(void* hTile); Arguments Name Type Comment hTile void* A handle to a mosaic tile, as retrieved by the zmap_GetMosaicTile function. Return value A null pointer if: text/html 2017-08-31T04:53:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_tile_getminmaxalt&rev=1504155215&do=diff Description Get the minimum and maximum altitude within a mosaic tile (applies to the map types of MAP_Heightfield and MAP_WaterMap only.) Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_tile_GetMinMaxAlt(void* hTile, float& minval, float& maxval); text/html 2017-08-31T04:58:50+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_tile_getpixel&rev=1504155530&do=diff Description Get the value of a pixel in a mosaic tile. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_tile_GetPixel(void* hTile, long x, long y, void* pValue); Arguments Name Type Comment hTile void* A handle to a mosaic tile, a pixel of which is to be retrieved (see zmap_GetMosaicTile). x long The x-coordinate of the pixel within the tile. y long The y-coordinate of the pixel within the tile. pValue void* A poin… text/html 2017-08-31T04:48:23+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_tile_gettilecoords&rev=1504154903&do=diff Description Get the x and y coordinates of of a tile in a mosaic. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_tile_GetTileCoords(void* hTile, long& x, long& y); Arguments Name Type Comment hTile void* A handle to a tile, the coordinates of which are to be retrieved. x long& A long integer, passed by reference, that is to receive the x coordinate. y long& A long integer, passed by reference, that is to receive the y … text/html 2017-08-31T04:49:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_tile_markchanged&rev=1504154944&do=diff Description Mark a tile in a mosaic map as being modified, so that when the tile is paged out of memory the changes are saved to disk rather than discarded. This function is required when the caller has directly modified the contents of a tile using zmap_tile_GetDataPtr. This function is not required if the map contents are changed using the zmap_SetPixel or zmap_tile_SetPixel functions, as these functions automatically mark the tile as being changed. text/html 2017-08-31T05:46:43+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_tile_setlock&rev=1504158403&do=diff Description Depending on the function arguments, this function: * Locks a mosaic tile in memory so that it will not be de-cached until the lock is released, or; * Releases the lock on a mosaic tile. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_tile_SetLock(void* hTile, bool LockState); text/html 2017-08-31T04:39:35+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmap_tile_setpixel&rev=1504154375&do=diff Description Set the value of a pixel in a mosaic tile. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zmap_tile_SetPixel(void* hTile, long x, long y, void* pValue); Arguments Name Type Comment hTile void* A handle to a mosaic tile, a pixel of which is to be set (see zmap_GetMosaicTile). x long The x-coordinate of the pixel within the tile. y long The y-coordinate of the pixel within the tile. pValue void* A pointer (o… text/html 2017-08-31T04:32:29+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zmenu_insertitem&rev=1504153949&do=diff Description Add an item to the menu in L3DT. Files Declaration zmenu.h Implementation zmenu.cpp Function prototype bool zmenu_InsertItem(const char* lpScript, const char* lpItemText, unsigned long MenuContext, unsigned long Flags); Arguments Name Type Comment lpFnName const char* A pointer to a C-style string containing the ZeoScript script to be executed by this menu option when selected. lpOptionName const char* A pointer to a C-style string containing the di… text/html 2017-08-31T05:52:12+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zprogbox_hidewnd&rev=1504158732&do=diff Description Closes an open progress bar window. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zprogbox_HideWnd(ZVAR hProgWnd); Arguments Name Type Comment hProgWnd ZVAR A ZVAR handle of type VarID_progbox. Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T05:29:49+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zprogbox_setprogress&rev=1504157389&do=diff Description Set the current progress in a progress bar window. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zprogbox_SetProgress(ZVAR hProgWnd, __int64 p, __int64 pmax); Arguments Name Type Comment hProgWnd ZVAR A ZVAR handle of type VarID_progbox. p A signed 64-bit integer, representing the current progress. pmax __int64 A signed 64-bit integer, representing the maximum progress of the progress bar. Return value False… text/html 2017-08-31T05:41:55+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zprogbox_settitle&rev=1504158115&do=diff Description Set the title of a progress bar window. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zprogbox_SetTitle(ZVAR hProgWnd, const char* lpTitleText); Arguments Name Type Comment hProgWnd ZVAR A ZVAR handle of type VarID_progbox. lpTitleText const char* A pointer to a C-style string containing the new name of the progress window. Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T07:05:55+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zprogbox_showwnd&rev=1504163155&do=diff Description Displays a progress bar window. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zprogbox_ShowWnd(ZVAR hProgWnd, unsigned long Flags); Arguments Name Type Comment hProgWnd ZVAR A ZVAR handle of type VarID_progbox. Flags unsigned long An unsigned long integer containing a bitwise combination of flags. See comments for supported flag values. Return value False if an error has occurred, and true otherwise. text/html 2017-08-31T05:29:59+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_addclimatea&rev=1504157399&do=diff Description Add a climate to the list of climates loaded in the project. Climates must be added to the project's climate list before they can be assigned in the design map or the attributes map. Files Declaration zProj.h Implementation zProj.cpp Function prototype long zproj_AddClimateA(const char* lpCliName); text/html 2017-08-31T06:47:27+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_createmap&rev=1504162047&do=diff Description Create a new map layer in the application's project, and retrieve the handle. Files Declaration zProj.h Implementation zProj.cpp Function prototype ZMAP zproj_CreateMap(const char* lpMapName); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name or mnemonic for the new map layer. Return value Null if: text/html 2017-08-31T06:51:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_demandsave&rev=1504162316&do=diff Description Display a message box notifying the user that the project must be saved to continue, and provide a 'save as' window to save the project. Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_DemandSave(); text/html 2017-08-31T05:57:06+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_free&rev=1504159026&do=diff Description Close the current map project, release all project's maps, and clear all project settings. Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_Free(); Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:09:00+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_getheightfieldrange&rev=1504156140&do=diff Description Get the minimum and maximum heights in the current project's heightfield, measured in metres above sea level. Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_GetHeightfieldRange(float& minval, float& maxval); text/html 2017-08-31T06:03:30+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_getmap&rev=1504159410&do=diff Description Retrieve a handle to a map layer from the application's project. Files Declaration zProj.h Implementation zProj.cpp Function prototype ZMAP zproj_GetMap(const char* lpMapName); Arguments Name Type Comment lpMapName const char* A handle to a C-style string containing the name of the map to be retrieved. See comments for legal values. Return value Null if an error occurred, and a valid non-null ZMAP handle otherwise. text/html 2017-08-31T06:12:55+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_getmapalternatename&rev=1504159975&do=diff Description Get the alternative name of a map in the project, either the 'long' display name (e.g. “Heightfield”) or the 'short' abbreviated name (e.g. “HF”). Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_GetMapAlternateName(const char* lpMapName, ZSTR hAltName, bool GetLongName = true); text/html 2017-08-31T05:07:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_getmaplist&rev=1504156024&do=diff Description Retrieve a handle to the project's map list. Files Declaration zProj.h Implementation zProj.cpp Function prototype ZLIST zproj_GetMapList(); Return value A valid non-null handle to the project's map list, or a null handle if an error occurred. text/html 2017-08-31T05:59:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_getorcreatemap&rev=1504159142&do=diff Description Retrieve a handle to a map layer in the application's project. If the map layer is not found in the project, the map layer is created. Files Declaration zProj.h Implementation zProj.cpp Function prototype ZMAP zproj_GetOrCreateMap(const char* lpMapName); text/html 2017-08-31T05:18:31+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_getprojectfilename&rev=1504156711&do=diff Description Retrieve the full path to the the current project file. Files Declaration zProj.h Implementation zProj.cpp Function prototype const char* zproj_GetProjectFilename(void); Arguments None. Return value A handle to a C-style string containing the full path to the project filename, including drive, directory, filename and extension. If the project has not been saved, a null pointer is returned. text/html 2017-08-31T04:14:07+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_getsettingslist&rev=1504152847&do=diff Description Retrieve the settings list for the application project. Files Declaration zProj.h Implementation zProj.cpp Function prototype ZLIST zproj_GetSettingsList(void); Arguments None. Return value Null if an error occurred, and otherwise a non-null handle to a variable of type VarID_varlist, containing the project's settings. text/html 2017-08-31T04:27:58+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_init&rev=1504153678&do=diff Description Initialise the application's map project. Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_Init(); Return value False if an error occurred, and true otherwise. Comments None. text/html 2017-08-31T06:40:20+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_isinit&rev=1504161620&do=diff Description Test whether the current project is initialised. Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_IsInit(); Return value True if the project has been initialised, and false otherwise. Comments None. text/html 2017-08-31T06:55:59+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_ispathok&rev=1504162559&do=diff Description Determine whether the project has been saved and its path name is valid. Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_IsPathOK(); Return value True if the project has been saved, and false otherwise. text/html 2017-08-31T04:58:54+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_loadproject&rev=1504155534&do=diff Description Load an existing project from disk. Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_LoadProject(const char* lpProjName); Arguments Name Type Comment lpProjName const char* A pointer to a C-style string containing the full path name to the project that is to be loaded. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:34:53+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_nclimates&rev=1504164893&do=diff Description Count the number of climates loaded in the current project (see zproj_AddClimateA). Files Declaration zProj.h Implementation zProj.cpp Function prototype long zproj_nClimates(); Return value An integer containing the number of climates loaded into the current project. Errors return 0. text/html 2017-08-31T07:25:02+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zproj_saveproject&rev=1504164302&do=diff Description Save the current project file (*.proj), map definition file (*.def.xml), and any unsaved/modified map files. Files Declaration zProj.h Implementation zProj.cpp Function prototype bool zproj_SaveProject(); Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:26:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zstr_gettext&rev=1504160802&do=diff Description Retrieve the value of a string variable, as a C-style string. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype const char* zstr_GetText(ZVAR hStr); Arguments Name Type Comment hStr ZVAR A ZVAR handle to a string variable, the value of which is to be retrieved. Return value Null if an error occurred, and a valid C-string handle otherwise. text/html 2017-08-31T05:42:16+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zstr_settext&rev=1504158136&do=diff Description Set the value of a string variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zstr_SetText(ZVAR hStr, const char* lpText); Arguments Name Type Comment hStr ZVAR A ZVAR handle to a string, the value of which is to be set. lpText const char* The value to be set, as a C-style string. Return value False if an error occurs, and true otherwise. text/html 2017-08-31T05:39:16+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:ztype_getid&rev=1504157956&do=diff Description Get the variable type ID corresponding to a given variable type name. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long ztype_GetID(const char* lpTypeName); Arguments Name Type Comment lpTypeName const char* A pointer to a C-stlye string containing the name of the variable type for which the type ID is to be retrieved. Return value Zero if an error occurred or the type name is not recognised, and non-zero otherwise (can be positive or n… text/html 2017-08-31T05:06:06+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:ztype_getname&rev=1504155966&do=diff Description Get the name of a variable type, as a string variable, corresponding to a given variable type ID. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool ztype_GetName(long VarID, ZVAR hStringVar); Arguments Name Type Comment VarID long The variable type ID for which the corresponding name string is to be retrieved. hStringVar ZVAR A ZVAR handle to a user-supplied string variable (created with zvar_Create, zvar_CreateShared or zlist_CreateIte… text/html 2017-08-31T07:32:21+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_cast&rev=1504164741&do=diff Description Cast the value of a variable to another variable type. Files Declaration helper/zVarCast.h Implementation helper/zVarCast.cpp Function prototype bool zvar_Cast(ZVAR hVarDest, long DestVarID, ZVAR hVarSrc); Arguments Name Type Comment hVarDest ZVAR A handle to a variable that is to receive the value of hVarSrc after type casting. DestVarID long The desired variable type of the variable addressed by hVarDest (see comments). hVarSrc ZVAR A handle to the variable co… text/html 2017-08-31T05:26:44+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_copyvalue&rev=1504157204&do=diff Description Copy the value of one variable to another. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_CopyValue(ZVAR hVarDest, ZVAR hVarSrc); Arguments Name Type Comment hVarDest ZVAR A ZVAR handle to the destination variable, the value of which will be overwritten. vVarSrc ZVAR A ZVAR handle to the source variable, the value of which will overwrite the value of hVarDest. Return value False if: text/html 2017-08-31T06:18:44+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_create&rev=1504160324&do=diff Description Create a variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZVAR zvar_Create(long VarID); Arguments Name Type Comment VarID long The type ID of the variable to be created. Return value Null if an error occurred, and a non-nullZVAR handle otherwise. text/html 2017-08-31T06:16:37+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_createshared&rev=1504160197&do=diff Description Create a named variable that may be accessed by other plugins, scripts, etc. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZVAR zvar_CreateShared(long VarID, const char* lpVarName); Arguments Name Type Comment VarID long The type ID of the variable to be created. lpVarName const char* A pointer to a C-style string containing the name of the variable to be created (null if to be unnamed). Return value Null if an error occurred, and a n… text/html 2017-08-31T05:41:19+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_delete&rev=1504158079&do=diff Description Delete a variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_Delete(ZVAR& hVar); Arguments Name Type Comment hVar ZVAR& A ZVAR handle to the variable to be deleted, passed by reference. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T06:41:16+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_editui&rev=1504161676&do=diff Description Edit the value of a variable using L3DT’s standard variable editing graphical user interface. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_EditUI(ZVAR hVar, const char* lpPrompt, unsigned long Flags, ZLIST hOptions); text/html 2017-08-31T05:05:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_getdataptr&rev=1504155913&do=diff Description Retrieve the raw memory handle to the data contained within a ZVAR. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype void* zvar_GetDataPtr(ZVAR hVar); Arguments Name Type Comment hVar ZVAR The handle to variable for which the data pointer is to be retrieved. Return value A null pointer if: text/html 2017-08-31T06:51:40+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_getname&rev=1504162300&do=diff Description Retrieve the name of a variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype const char* zvar_GetName(ZVAR hVar); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the name of which is to be retrieved. Return value Null if an error occurred, and a non-null pointer to a C-style string otherwise. text/html 2017-08-31T05:12:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_getsharedvar&rev=1504156348&do=diff Description Retrieve the ZVAR handle of a shared variable by name. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype ZVAR zvar_GetSharedVar(const char* lpVarName); Arguments Name Type Comment lpVarName const char* A pointer to a C-style string naming the variable to be retrieved. Return value Null if an error occurred or the named variable does not exist, and a non-null ZVAR handle otherwise. text/html 2017-08-31T06:19:13+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_gettypeid&rev=1504160353&do=diff Description Retrieve the type ID of a variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype long zvar_GetTypeID(ZVAR hVar); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the type of which is to be retrieved. Return value Zero if an error occurred or the variable is not initialised, and a non-zero variable type ID otherwise (can be positive or negative.) text/html 2017-08-31T07:16:04+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_getvalue&rev=1504163764&do=diff Description Retrieve the value of a variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_GetValue(ZVAR hVar, void* pValue); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be retrieved. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, ready to receive the value from the ZVAR. Return value False if: text/html 2017-08-31T04:38:43+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_getvalueex&rev=1504154323&do=diff Description Retrieve the value of a variable, ensuring first it is of the correct variable type. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_GetValueEx(ZVAR hVar, long VarID, void* pValue); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be retrieved. VarID long The expected type ID of the variable. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data … text/html 2017-08-31T04:19:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_getvaluetext&rev=1504153168&do=diff Description Retrieve the value of a variable as a formatted text string. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_GetValueText(ZVAR hVar, ZSTR hStrVar); Arguments Name Type Comment hVar ZVAR A handle to a variable, the value of which is to be retrieved as text string. hStrVar ZSTR A handle to a string variable (VarID_string), which is to receive the text value of the variable referenced by hVar. Return value False if an er… text/html 2017-08-31T05:32:40+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_istype&rev=1504157560&do=diff Description Test whether a variable is initialised as a given type ID. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_IsType(ZVAR hVar, long VarID); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the type of which is to be tested. VarID long A long integer containing the variable type ID to be tested. Return value False if: text/html 2017-08-31T06:55:48+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_reinit&rev=1504162548&do=diff Description Re-initialise a variable as another type. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_ReInit(ZVAR hVar, long VarID); Arguments Name Type Comment hVar ZVAR A handle the the variable to be re-initialised. VarID long The new variable type ID. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T05:41:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_rename&rev=1504158092&do=diff Description Changes the name of a variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_Rename(ZVAR hVar, const char* lpNewName); Arguments Name Type Comment hVar ZVAR A ZVAR handle to the variable to be renamed. lpNewName const char* A pointer to a C-style string containing the new name of the variable. Return value False if: text/html 2017-08-31T07:17:32+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_setvalue&rev=1504163852&do=diff Description Set the value of a variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_SetValue(ZVAR hVar, void* pValue); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be set. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, containing the value to be set. Return value False if: text/html 2017-08-31T07:13:28+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_setvalueex&rev=1504163608&do=diff Description Set the value of a variable, ensuring first it is of the correct variable type. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_SetValueEx(ZVAR hVar, long VarID, void* pValue); Arguments Name Type Comment hVar ZVAR A ZVAR handle to a variable, the value of which is to be set. VarID long The expected type ID of the variable. pValue void* A user-supplied handle to an allocated block of memory for the appropriate data type, conta… text/html 2017-08-31T05:07:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_setvaluetext&rev=1504156076&do=diff Description Set the value of a variable from an ASCII character string. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_SetValueText(ZVAR hVar, const char* lpValueText); Arguments Name Type Comment hVar ZVAR A ZVAR variable handle whose value is to be set. lpValueText const char* A handle to a C-style string containing the value (as text) to which the variable will be set. Return value False if an error occurred, and true otherwi… text/html 2017-08-31T05:19:03+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zvar_setvarref&rev=1504156743&do=diff Description Set a variable to be a reference (alias) of another variable. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zvar_SetVarRef(ZVAR hPtrVar, ZVAR hSrcVar); Arguments Name Type Comment hPtrVar ZVAR A ZVAR handle to a variable, which will become the reference/alias of hSrcVar. hSrcVar ZVAR A ZVAR handle to a variable, which is to be referenced by hPtrVar. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T04:25:56+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zview_getactivemap&rev=1504153556&do=diff Description Retrieve a handle to the map currently displayed in the application window. Files Declaration zView.h Implementation zView.cpp Function prototype ZMAP zview_GetActiveMap(void); Arguments None. Return value A null handle if no map is displayed, and a valid non-null ZMAP handle otherwise. text/html 2017-08-31T06:22:46+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zview_getselectedarea&rev=1504160566&do=diff Description Retrieve the selected area rectangle from L3DT's main map view. Files Declaration zView.h Implementation zView.cpp Function prototype bool zview_GetSelectedArea(ZSTR hMapName, LPRECT lpRect); Arguments Name Type Comment hMapName ZSTR A handle to a variable of type VarID_string that will receive the name of the map layer that corresponds to the selected area in the application's main window. lpRect LPRECT A handle to a RECT structure to receive the selected area coo… text/html 2017-08-31T05:22:25+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zview_refresh&rev=1504156945&do=diff Description Refresh the current map display in the application's main window. Files Declaration zView.h Implementation zView.cpp Function prototype bool zview_Refresh(bool RedrawBuffer); Arguments Name Type Comment RedrawBuffer bool A boolean flag that specifies whether the map display buffer must be re-generated prior to refreshing the screen. If false, the screen is refreshed with the old buffer contents. Return value False if an error occurred, and true otherwise. text/html 2017-08-31T07:02:42+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zview_setselectedarea&rev=1504162962&do=diff Description Set the extents of the selected area rectangle in L3DT’s main map view. Files Declaration zView.h Implementation zView.cpp Function prototype bool zview_SetSelectedArea(const char* lpProjMapName, LPRECT lpRect); Arguments Name Type Comment lpProjMapName const char* A handle to a C-style string containing the name of the map layer whose area is to be selected. If null, the selection is cleared. lpRect LPRECT A handle to a RECT structure containing the bound… text/html 2017-08-31T06:29:06+00:00 http://bundysoft.com/docs/doku.php?id=zeolite:functions:zview_showmap&rev=1504160946&do=diff Description Set the map displayed in the main window of L3DT. Files Declaration Zeolite.h Implementation Zeolite.cpp Function prototype bool zview_ShowMap(const char* lpProjMapName); Arguments Name Type Comment lpProjMapName const char* A pointer to a C-style string containing the name of the map layer to be displayed. Return value true, pretty much all the time.