6.8.60 DMcob_ValueGet

Diese Funktion dient dazu, aus Sammlungen einen einzelnen Elementwert zu holen, der zu einem definierten Index gehört.

Ist der definierte Index vom Typ DT-void, so wird der Gesamtwert zurückgegeben, was normalerweise einem Kopieren des Wertes entspricht.

Handelt es sich beim DM-Value-Parameter um einen ungemanagten Wert, so bleibt dieser auch ungemanagt. Bei der Rückgabe von Strings werden diese nur in einem temporären Puffer gemerkt, der beim nächsten Aufruf einer DM-Funktion ohne DMF-DontFreeLastStrings-Option wieder gelöscht bzw. überschrieben werden kann.

77 AnyValue pointer value null.

call "DMcob_ValueGet" using
            DM-StdArgs
            AnyValue
            DM-ValueIndex
            DM-Value.

Parameter

<-> DM-options of DM-StdArgs

Hier sind folgende Optionen möglich:

Option

Bedeutung

DMF-GetLocalString

Diese Option bedeutet, dass bei textuellen Werten (IDs vom Typ DT-text) diese als String in der aktuell eingestellten Sprache zurückgegeben werden sollen.

DMF-GetMasterString

Diese Option bedeutet, dass bei textuellen Werten (IDs vom Typ DT-text) diese als String in der Entwicklungssprache zurückgegeben werden sollen, unabhängig davon, mit welcher Sprache der Benutzer gerade arbeitet.

DMF-DontFreeLastStrings

Normalerweise werden Strings in einem temporären Puffer an die Anwendung übergeben, der bis zum nächsten Aufruf an den IDM erhalten bleibt. Sollen Strings länger in der Anwendung gültig sein, muss diese Option DMF-DontFreeLastStrings gesetzt werden. Der Speicher wird erst dann wieder freigegeben, wenn ein Aufruf an eine IDM-Funktion ohne diese Option erfolgt und dabei ein String vom IDM an die Anwendung zurückgegeben wird.

-> AnyValue

Handle des verwalteten Wertes. Es sollte eine gemanagte Wertereferenz oder Funktionsargument sein.

-> DM-ValueIndex

Dieser Parameter definiert den Index von dem der Elementwert geholt wird. Dieser Parameter muss kein gemanagter Wert sein. Falls DM-idx-datatype auf den Wert DT-void gesetzt ist, wird der DM-Value-Parameter zurückgegeben.

<- DM-Value

Dieser Parameter definiert den Wert, der gesetzt werden soll. Es kann sich dabei um eine gemanagte oder auch um eine ungemanagte Wertereferenz handeln.

Rückgabewert

DM-status of DM-StdArgs

DM-error

Der Wert konnte nicht geholt werden. Das kann auf fehlerhaften Aufruf, eine nicht gemanagte oder ungültige Wertereferenz oder eine fehlerhafte Indizierung hinweisen.

DM-success

Das Holen des Wertes war erfolgreich.

Verfügbarkeit

Nur COBOL-Schnittstelle für Micro Focus Visual COBOL.

Siehe auch

Funktion DMcob_ValueChange, DMcob_ValueCount, DMcob_ValueGetBuffer, DMcob_ValueIndex

Kapitel „Verwendung des Datentyps anyvalue“