Prototyp und Beschreibung der Funktion getunitname()

(Funktion der freischaltpflichtigen Gruppe " Parameterermittlung")

 

getunitname()
Ermittlung der Bezeichnung einer Maßeinheit.

Prototyp der DLL-Funktion in C++ Syntax (Kleinschreibung beachten!):
extern "C" __declspec(dllexport) unsigned long __stdcall getunitname(
     unsigned short nUnit,
     char **pszUnitName);

Prototyp der DLL-Funktion in Visual Objects Syntax:
_DLL function getunitname(;
     nUnit as word,;                       // 2 Byte
     pszUnitName ref psz);                 // 4 Byte, char**, 80 alloc.
as logic pascal:geodll32.getunitname      // 4 Byte

Die Allokation von Speicher für "ref psz" / "char**" ist nur notwendig,
wenn zuvor setstringallocate(FALSE) aufgerufen worden ist.


Die Funktion gibt die Bezeichnung der in nUnit übergebenen Maßeinheit als
Text im Parameter pszUnitName zurück. Der Text wird in der zuvor mit der
Funktion setLanguage() gesetzten Sprache zurückgegeben.


Die Parameter werden folgendermaßen übergeben bzw. zurückgegeben:
nUnit       Maßeinheit, für die die Bezeichnung ermittelt werden soll. Die
            verfügbaren Maßeinheiten sind in der Liste
            "Koordinatenbezugssysteme alphabetisch (unten)" aufgeführt.

pszUnitName Die Bezeichnung der Maßeinheit wird per Referenz zurückgegeben.
(ref)       Achtung: "ref pszUnitName" entspricht "char**" in C. Es müssen
            80 Bytes 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.


Der zurückgegebene Text sieht je nach der gewählten Maßeinheit etwa so aus:
   Internationales Meter (1.0 Meter)
      oder
   US Survey Fuß (0.30480061 Meter)


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.