Prototype and description of the function getunitpar()

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


Determination of the calculation constant of a Measurement Unit.

Prototype of the DLL function in C++ syntax (attend lower case!):
extern "C" __declspec(dllexport) unsigned long __stdcall getunitpar(
     unsigned short nUnit,
     double *nUnit2Meter);

Prototype of the DLL function in Visual Objects syntax:
_DLL function getunitpar(;
     nUnit as word,;                       // 2 Byte
     nUnit2Meter ref real8);               // 8 Byte
as logic pascal:geodll32.getunitpar       // 4 Byte

The function returns the calculation constant to meters of the Measurement
Unit fitting to nUnit as reference in the parameter nUnit2Meter to the
calling program.

The parameters are passed and/or returned as follows:
nUnit       Measurement Unit, for which the calculation constant is to be
            determined. The available Measurement Units are specified in the
            list "Coordinate Reference Systems alphabetical (bottom)".

nUnit2Meter The calculation constant or the Measurement Unit to meters is
(ref)       returned by reference.

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.