Prototype and description of the function getcoordsys()

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


Determination of the designation, the projection method and the projection
parameters of a Coordinate System.

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

Prototype of the DLL function in Visual Objects syntax:
_DLL function getcoordsys(;
     wCoordSysQ as word,;                  // 2 Byte
     pszCoordSys ref psz);                 // 4 Byte, char**, 800 alloc.
as logic pascal:geodll32.getcoordsys       // 4 Byte

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

The function returns the designation, the projection method, the
designations and values of the projection parameters and other values
fitting to the Coordinate System wCoordSys as formatted text in the
variable pszCoordSys. 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 values and designations of
            the Coordinate System parameters are to be determined. The
            available Coordinate Systems are specified in the list
            "Coordinate Reference Systems".

pszCoordSys The Coordinate System parameters will be provided together
(ref)       with their descriptions in a formatted text and returned by
            reference. The lines of the text are separated with "Return
            and Linefeed".
            Note: "ref pszCoordSys" corresponds to "char**" in C. 800 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 formatted text looks dependently of the Coordinate System e.g.
like this:
   French Lambert zone II (centre)
   Lambert Conformal Conic Projection (1 SP)
   0002.3372292 Longitude of grid origin [degrees]
   0046.8000000 Latitude of standard parallel [degrees]
   000600000.00 False easting [meter]
   000200000.00 False northing [meter]
   00.999877420 Scale factor

   Coordinate System range:
   Longitude -7 to 12 degrees
   Latitude 41 to 52 degrees

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.