Prototype and description of the function getellname()

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

 

getellname()
Determination of the designation of a geodetic ellipsoid.

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

Prototype of the DLL function in Visual Objects syntax:
_DLL function getellname(;
     wEllipsoid as word,;                  // 2 Byte
     pszEllName ref psz);                  // 4 Byte, char**, 80 alloc.
as logic pascal:geodll32.getellname        // 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 geodetic ellipsoid passed as
parameter wEllipsoid as a text string in the parameter pszEllName. The text
is returned in the language set by the function setLanguage() before.


The parameters are passed and/or returned as follows:
wEllipsoid  Number of the ellipsoid, for which the designation is to be
            determined. The ellipsoid numbers are specified at the bottom
            part of the list "Systems sorted alphabetical".
            The numbers of the Reference Systems specified in the list
            "Systems sorted by countries" can be used also.

pszEllName  The designation of the ellipsoid is returned by reference (ref).
 (ref)      Note: "ref pszEllName" 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 text looks dependently of the geodetic ellipsoid or reference
system e.g. like this:
   Bessel (1841)
      or
   Krassowskij (1942)


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.