blob: 32883b3076e95eb2794f8369767d4ad40ac2a4de [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +01001SetProp()
2=========
3
4FUNKTION
5--------
6::
7
8 public mixed SetProp(string name, mixed Value);
9
10DEFINIERT IN
11------------
12::
13
14 /std/thing/properties.c
15 /sys/thing/properties.h (Prototyp)
16
17ARGUMENTE
18---------
19::
20
21 name - Property, deren Wert veraendert werden soll.
22 Value - Wert, auf den der Inhalt der Property gesetzt werden soll
23
24BESCHREIBUNG
25------------
26::
27
28 Der Datenwert der Property 'name' wird auf den Wert 'Value' gesetzt.
29
30 Existiert eine F_SET_METHOD oder eine _set_'name'()-Methode fuer
31 diese Property, so wird diese aufgerufen und ihr 'Value' uebergeben.
32 Eine F_SET_METHOD hat dabei Vorrang vor _set_'name'(), d.h.
33 _set_'name'() wird nach erfolgreicher F_QUERY_METHOD nicht mehr
34 gerufen.
35
36 (Diese Methoden nutzen dann Set(), um den Datenwert der Property
37 'name' zu aendern. Teilweise werden aber auch interne Variablen so
38 oeffentlich gemacht und sind nicht in der ueber Set/Query verfuegbaren
39 Property 'name' abgelegt.)
40
41RUeCKGABEWERT
42-------------
43::
44
45 Der Wert, der nun in der Property gespeichert ist.
46 In der Regel ist das 'Value'. Wenn die Property ueber eine SET_METHOD
47 oder eine _set_'name'()-Funktion verfuegt und diese 'Value' aendert
48 (zum Beispiel, indem sie 'Value' an einen bestimmten erlaubten
49 Wertebereich anpasst), kann der Rueckgabewert jedoch auch veraendert
50 sein.
51
52 Wenn die Property nicht veraendert werden darf, wird -1 zurueckgegeben.
53
54BEISPIELE
55---------
56::
57
58 // geben wir dem Zwerg eine Kurzbeschreibung
59 SetProp(P_SHORT, "Ein kleiner Zwerg");
60
61SIEHE AUCH
62----------
63::
64
65 Aehnliches: QueryProp(L), Set(L), Query(L)
66 Generell: SetProperties(L), QueryProperties(L)
67 Konzept: properties, /std/thing/properties.c
68
6915.Dez 2004 Gloinson
70