3.34 DM_GetValue

Mit Hilfe dieser Funktion werden Sie in die Lage versetzt, Attribute von DM-Objekten zu erfragen

Die dabei zulässigen Attribute für den jeweiligen Objekttyp entnehmen Sie bitte der „Objektreferenz“.

Hinweis

Bei Verwendung in Funktionen, welche Records als Parameter enthalten, beachten Sie bitte die Hinweise im Kapitel „Behandlung von String-Parametern“ und das Kapitel „Hinweis bei Verwendung von DM-Funktionen“ im Handbuch „C-Schnittstelle - Grundlagen“.

DM_Boolean DML_default DM_EXPORT DM_GetValue
(
  DM_ID objectID,
  DM_Attribute attr,
  DM_UInt index,
  DM_Value *data,
  DM_Options options
)

Parameter

-> DM_ID objectID

Dieser Parameter beschreibt das Objekt, dessen Attribut Sie erfragen möchten.

-> DM_Attribute attr

Dieser Parameter beschreibt das Attribut, das Sie von dem Objekt erfragen möchten. Alle zugelassenen Attribute sind in der Datei IDMuser.h definiert.

-> DM_UInt index

Dieser Parameter wird nur bei Vektorattributen von Objekten ausgewertet und beschreibt den Index des gesuchten Unterobjekts (z.B. Text in Listbox).

-> DM_Value*data

In diesem Parameter erhalten Sie den Wert des gesuchten Attributes. Dabei müssen Sie unbedingt beachten, dass Sie das richtige Element aus dieser Union auslesen. Den Datentyp eines jeden Attributes entnehmen Sie bitte der „Attributreferenz“.

-> DM_Options options

Mit Hilfe dieses Parameters wird u.a. gesteuert, in welcher Form Texte vom Dialog Manager aus zurückgeliefert werden, falls das entsprechende Attribut vom Typ Text ist. Folgende Belegungen sind für diesen Parameter möglich:

Option

Bedeutung

DMF_GetMasterString

Diese Option bedeutet, dass bei textuellen Attributen der String in der Entwicklungssprache zurückgegeben werden soll, unabhängig davon, mit welcher Sprache der Benutzer gerade arbeitet.

DMF_GetLocalString

Diese Option bedeutet, dass bei textuellen Attributen der String in der aktuell eingestellten Sprache zurückgegeben werden soll.

DMF_GetTextID

Diese Option bedeutet, dass bei textuellen Attributen der String als TextID zurückgegeben werden soll. Diese ist dann sinnvoll, wenn der Text einem anderen Objekt zugewiesen werden soll.

DMF_DontFreeLastStrings

Normalerweise werden Strings in einem temporären Puffer an die Anwendung übergeben, der bis zum nächsten Aufruf an den Dialog Manager 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 DM-Funktion ohne diese Option erfolgt und dabei ein String vom DM an die Anwendung zurückgegeben wird.

Rückgabewert

TRUE

Das Attribut konnte erfolgreich erfragt werden.

FALSE

Das Attribut ist für das Objekt nicht zulässig.

Beispiel

Erfragen des Inhalts eines editierbaren Textes in einer Objekt-Callback-Funktion.

DM_Boolean DML_default DM_CALLBACK CheckFilename __1(

  (DM_CallBackArgs *, data))

{

  DM_Value value;    /*structure for DM_GetValue*/

 

  /* get current contents */

  if (DM_GetValue(data->object, AT_content, 0, &value,

                  DMF_GetLocalString))

    /* check the datatype */

    if(value.type == DT_string)

Siehe auch

Eingebaute Funktion getvalue() im Handbuch „Regelsprache“

Methode :get()