Funktion getcoordaxis()

Prototyp und Beschreibung der Funktion getcoordaxis()

(Funktion der freischaltpflichtigen Gruppe " Parameterermittlung")

 

getcoordaxis()
Ermittlung der Achsenbezeichnungen eines 2D-Koordinatensystems.

Prototyp der DLL-Funktion in C++ Syntax (Kleinschreibung beachten!):
extern "C" __declspec(dllimport) unsigned long __stdcall getcoordaxis(
     unsigned short wCoordSys,
     char **pszCoordAxEa,
     char **pszCoordAxNo);

Prototyp der DLL-Funktion in Visual Objects Syntax:
_DLL function getcoordaxis(;
     wCoordSys as word,;                   // 2 Byte
     pszCoordAxEa ref psz,;                // 4 Byte, char**, 30 alloc.
     pszCoordAxNo ref psz);                // 4 Byte, char**, 30 alloc.
as logic pascal:geodll32.getcoordaxis      // 4 Byte

Die Allokation von Speicher für die zurückzugebenden psz ist nur dann
wenn zuvor setstringallocate(FALSE) aufgerufen worden ist.


Die Funktion gibt die Achsenbezeichnungen des in wCoordSys übergebenen
2D-Koordinatensystems als Texte in den Parametern pszCoordAxEa (Ostachse)
und pszCoordAxNo (Nordachse) zurück. Die Achsenbezeichnungen werden in
der zuvor mit der Funktion setLanguage() gesetzten Sprache zurückgegeben.


Die Parameter werden folgendermaßen übergeben bzw. zurückgegeben:
wCoordSys   Koordinatensystem, für das die Achsenbezeichnungen ermittelt
            werden sollen. Die verfügbaren Koordinatensysteme sind in der
            Liste "Koordinatenbezugssysteme" aufgeführt.

pszCoordAxEa Die Achsenbezeichnung der Ostachse des Koordinatensystems
(ref)       wird per Referenz zurückgegeben.
            Achtung: "ref pszCoordAxEa" entspricht "char**" in C. Es müssen
            30 Byte Speicher für den Null terminated string in Abhängigkeit
            vom Aufruf der Funktion setstringallocate() allokiert werden.
            Beachten Sie dazu die Hinweise in der Beschreibung der Funktion
            setstringallocate()".

pszCoordAxNo Die Achsenbezeichnung der Nordachse des Koordinatensystems
(ref)       wird per Referenz zurückgegeben.
            Achtung: "ref pszCoordAxNo" entspricht "char**" in C. Es müssen
            30 Byte Speicher für den Null terminated string in Abhängigkeit
            vom Aufruf der Funktion setstringallocate() allokiert werden.
            Beachten Sie dazu die Hinweise in der Beschreibung der Funktion
            setstringallocate()".

returnWert  Im Fehlerfall gibt die Funktion FALSE zurück, sonst TRUE.


Die zurückgegebenen Achsenbezeichnungen sehen je nach dem gewählten
Koordinatensystem etwa so aus:
  Rechts     Hoch
oder
  Länge      Breite


Freischaltung:
Die Funktion ist Bestandteil der freischaltpflichtigen Funktionsgruppe
"Parameterermittlung". Sie wird zusammen mit den anderen Funktionen
der Gruppe durch die Eingabe der bei der Vertriebsfirma erworbenen
Freischaltparameter per Aufruf der Funktion setunlockcode() zur
uneingeschränkten Nutzung frei geschaltet. Ohne die Freischaltung sind nur
wenige Funktionsaufrufe zu Testzwecken (Sharewareprinzip) möglich.