Prototype and description of the function getrefname()

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


Determination of the designation of a geodetic Reference System.

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

Prototype of the DLL function in Visual Objects syntax:
_DLL function getrefname(;
     wRefSys as word,;                     // 2 Byte
     pszRefName ref psz);                  // 4 Byte, char**, 80 alloc.
as logic pascal:geodll32.getrefname        // 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 Reference System
fitting to wRefSys as text in the parameter pszRefName to the calling
program. The text is returned in the language set by the function
setLanguage() before.

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

pszRefName  The designation or the geodetic Reference System is returned
(ref)       by reference.
            Note: "ref pszRefName" 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

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

The returned text looks dependently of the geodetic Reference System e.g.
like this:
   ETRS89 (Europe), geocentric, GRS80
   NAD27 (US west), Meade's Ranch Kansas, Clarke

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.