Prototype and description of the function getcoordfixref()

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


Determining whether a Coordinate System has a fixed Reference System.

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

Prototype of the DLL function in Visual Objects syntax:
_DLL function getcoordfixref(;
     wCoordSys as word,;                   // 2 Byte
     lIsFixed ref logic);                  // 4 Byte
as logic pascal:geodll32.getcoordfixref    // 4 Byte

The function determines whether the Coordinate System passed in wCoordSys
has a fixed Reference System and returns the status in the variable
lIsFixed. Fixed reference systems are common, for example, in the German
"Lagestatus" systems or in the Google World Coordinates systems.

The fixed Reference System for the Coordinate System can be determined with
the function getcoordstdrefsys() by querying the pre-defined standard
Reference System.

GeoDLL does not use the fixed Reference System automatically. Even if the
flag lIsFixed is set, any reference systems can be used in the functions
coordtrans???(). But by querying the status "Fixed Reference System" with
the function getcoordfixref(), the calling program can react. For example,
the program can only allow the default Reference System which can be
determined with the getcoordstdrefsys() function.

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

lIsFixed    Status "Fixed Reference System". The status is returned by
(ref)       reference.
TRUE        The Coordinate System has a fixed Reference System.
FALSE       The Coordinate System has not a fixed Reference System.

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.