Prototype and description of the function getcoordstdunitpar()

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


Determination of the default Measurement Unit of a Coordinate System.

Prototype of the DLL function in C++ syntax (attend lower case!):
extern "C" __declspec(dllexport) unsigned long __stdcall getcoordstdunitpar(
     unsigned short nCoordSys,
     unsigned short *nStdUnit,
     unsigned short *nFixUnit,
     unsigned short *nNoUnit);

Prototype of the DLL function in Visual Objects syntax:
_DLL function getcoordstdunitpar(;
     nCoordSys as word,;                   // 2 Byte
     nStdUnit ref word,;                   // 4 Byte
     nFixUnit ref word,;                   // 4 Byte
     nNoUnit ref word);                    // 4 Byte
as logic pascal:geodll32.getcoordstdunitpar

The function returns the number of a Measurement Unit and its attributes to
the calling program, which are usually used for a Coordinate System and which
are stored as standard in GeoDLL.

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

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

nFixUnit    Flag for the exclusive use of the Measurement Unit in the passed
(ref)       Coordinate System.
            0:  The use of different Measurement Units is possible.
            1:  The Measurement Unit is used exclusively.

nNoUnit     Flag for the consideration of the Measurement Unit in the passed
(ref)       Coordinate System.
            0:  One or more Measurement Units can be considered.
            1:  A Measurement Unit has no effect.

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

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.