Prototype and description of the function getcoordname()

(Function of the unlock requiring group "Parameter determination")

 

getcoordname()
Determination of the designation of a Coordinate System.

Prototype of the DLL function in C++ syntax (attend lower case!):
extern "C" __declspec(dllimport) unsigned long __stdcall getcoordname(
     unsigned short wCoordSys,
     char **pszCoordName);

Prototype of the DLL function in Visual Objects syntax:
_DLL function getcoordname(;
     wCoordSys as word,;                   // 2 Byte
     pszCoordName ref psz);                // 4 Byte, char**, 80 alloc.
as logic pascal:geodll32.getcoordname      // 4 Byte

The allocation of memory for "ref psz" / "char**" is necessary only if
setstringallocate(FALSE) is called before.


The function returns the designation of the Coordinate System fitting
to wCoordSys as formatted text in the variable pszCoordName. The text is
returned in the language set by the function setLanguage() before.


The parameters are passed and/or returned as follows:
wCoordSys   Coordinate System, for which the designation is to be
            determined. The available Coordinate Systems are specified in
            the list "Coordinate Reference Systems".

pszCoordName The designations of the Coordinate System is returned by
(ref)       reference.
            Note: "ref pszCoordName" corresponds to "char**" in C. 80 bytes
            of memory for the zero terminated string must be allocated with
            dependence to the call of the function setstringallocate().
            Please consider the notes in the description of the function
            setstringallocate().

returnVal   In case of an error the function returns FALSE, otherwise TRUE.


The returned string looks depending upon the selected Coordinate System
e.g. like this:
   Swiss grid coordinates (LV03)
      oder
   Belgian Lambert72 coordinates


Unlocking
This function is a component of the unlock requiring function group
"parameter determination". It is unlocked for unrestricted use together with
the other functions of the group by passing the unlock parameters, acquired
from the software distribution company, trough the function setunlockcode().
Without unlocking only a few function calls for test purposes (shareware
principle) are possible.