3.81 DM_ValueIndex
Mit dieser Funktion kann der zu einer Position zugehörige Index einer Sammlung ermittelt werden. Dies ist vor allem wichtig für Werte vom Typ DT_hash und DT_matrix um so auf einfachste Weise auf alle zugehörigen Indizes zugreifen zu können. Die Funktion erlaubt nur den Zugriff auf Indizes die nicht zu Standardwerten gehören.
Der zurückgelieferte Index kann in einem gemanagten retvalue-Parameterwert abgelegt werden oder in einem ungemanagten. Bei letzterem wird wenn nötig eine Allokierung des String-Wertes im temporären Puffer ausgeführt.
DM_UInt DML_default DM_EXPORT DM_ValueIndex
(
DM_Value *value,
DM_UInt indexpos,
DM_Value *retvalue,
DM_Options options
)
Parameter
-> DM_Value* value
Diese Parameter verweist auf die Wertereferenz, von welcher der Index an der Position geholt wird. Es muss eine gemanagte Wertereferenz oder Funktionsargument sein.
-> DM_UInt indexpos
Dieser Parameter definiert die Position des Index und sollte zwischen 0 < indexpos <= DM_ValueCount() liegen.
-> DM_Value * retvalue
Wenn dieser Parameter nicht NULL ist, wird hier der entsprechende Index abgelegt. Es kann sich dabei um eine gemanagte oder auch um eine ungemanagte Wertereferenz handeln.
If this parameter is not NULL, the retrieved index is stored here. This may be a managed or an unmanaged value reference.
-> DM_Options options
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. |
Rückgabewert
|
DM_TRUE |
Der Wert hat einen Index an dieser Position, der geholte Index steht danach in *retvalue falls retvalue != NULL ist. |
|
DM_FALSE |
Der Index konnte nicht ermittelt werden. Das kann auf einen fehlerhaften Aufruf, eine nicht gemanagte oder ungültige Wertereferenz oder eine fehlerhafte Position hinweisen. |
Beispiel
dialog YourDialog
function anyvalue FindData(hash DataHash, string Pattern,
anyvalue FirstIndex output);
on dialog start
{
variable hash Stations := ["1"=>"ARD ","2"=>"ZDF ","9"=>"SWR3 "];
variable anyvalue Idx;
print "Found(D)=" + FindData(Stations,"D",Idx);
print " at " + Idx;
exit();
}
...
static DM_Value InvalidIndex;
static DM_Value InvalidValue;
DM_Value * DML_default DM_ENTRY FindData(DM_Value *DataHash, DM_String Pattern,
DM_Value *FirstIndex)
{
DM_Value index;
DM_Value value;
/* initialize the managed values */
DM_ValueInit(&index, DT_void, NULL, 0);
DM_ValueInit(&value, DT_void, NULL, 0);
DM_StringInit(&retString, 0);
count = DM_ValueCount(DataHash, NULL, 0);
while(count>0)
{
/* loop through the hash */
if (DM_ValueIndex(DataHash, count--, &index, 0)
&& DM_ValueGet(DataHash, &index, &value, DMF_GetLocalString)
&& value.type == DT_string)
{
if (strstr(value.value.string, Pattern))
{
/* return the first found index & value */
DM_ValueChange(FirstIndex, NULL, &index, 0);
return DM_ValueReturn(&value, 0);
}
}
}
/* return the invalid index & value */
DM_ValueChange(FirstIndex, NULL, &InvalidIndex, 0);
return &InvalidValue;
}
...
int DML_c AppMain __2((int, argc), (char **,argv))
{
DM_Value data;
...
data.type = DT_string;
data.value.string = "NO-VALUE";
DM_ValueChange(&InvalidValue, NULL, &data, DMF_StaticValue);
data.type = DT_string;
data.value.string = "INVALID-INDEX";
DM_ValueChange(&InvalidIndex, NULL, &data, DMF_StaticValue);
...
DM_StartDialog(...)
Verfügbarkeit
Siehe auch
Method
Support