Prototype and description of the function getcoordstdrefsys()

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


Determination of the pre-defined standard Reference System for a coordinate

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

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

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

The function returns the Reference System as designation and as number to
the calling program, which are usually used for a Coordinate System and which
are stored as standard in GeoDLL. The designation is returned in the language
set before by the function setLanguage().

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

pszRefSys   Standard Reference System, which is intended within the GeoDLL
(ref)       for the passed Coordinate System, in alphanumeric short form.
            Note: "ref pszRefSys" 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

wRefSys     Standard Reference System, which is intended within the GeoDLL
(ref)       for the passed Coordinate System, as number.
            The number correspondents to the Reference Systems specified
            in the list "Coordinate Reference Systems".

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

The returned standard Reference System and the corresponding number looks
dependently of the Coordinate System e.g. like
   for UTM (northern hemisphere) coordinates:
      WGS84   10
   or for British Transversal Mercator:
      OSGB36  13

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.