blob: cc10d344521708743ae9e79e67d275c290e454b5 [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +01001log_file()
2==========
3
4FUNKTION
5--------
Zesstra18626972017-01-31 10:38:27 +01006
Zesstra1cd2f9e2018-09-05 17:01:41 +02007 varargs int log_file(string file, string text, int size_to_break)
Zesstra18626972017-01-31 10:38:27 +01008
9ARGUMENTE
10---------
Zesstra18626972017-01-31 10:38:27 +010011
Zesstra1cd2f9e2018-09-05 17:01:41 +020012 file
13 Name der Datei, in die geschrieben werden soll
14
15 text
16 Der Text, der geschrieben werden soll
17
18 size_to_break
19 Groesse, ab der ein neues File begonnen wird (optional)
Zesstra18626972017-01-31 10:38:27 +010020
21BESCHREIBUNG
22------------
Zesstra18626972017-01-31 10:38:27 +010023
Zesstra1cd2f9e2018-09-05 17:01:41 +020024 log_file schreibt den Text text in die Datei /log/file.
25 Sollte file schon mit einem /log/ beginnen, wird kein erneutes /log/ davor
26 eingefuegt.
27 Falls das Zielverzeichnis unterhalb von /log/ noch nicht existiert, wird
28 dies automatisch angelegt, sofern das rufende Objekt das Logfile schreiben
29 darf.
Zesstra18626972017-01-31 10:38:27 +010030
31RUECKGABEWERT
32-------------
Zesstra18626972017-01-31 10:38:27 +010033
34 1 bei Erfolg oder 0, falls ein Fehler beim Schreiben auftrat.
35
36BEMERKUNGEN
37-----------
Zesstra18626972017-01-31 10:38:27 +010038
39 Wenn die Groesse von file vor dem Schreiben 50000 Bytes ueberschreitet,
40 wird sie in file.old umbenannt. Eine schon vorhandene Datei file.old
41 wird dabei geloescht. Der Text wird nach dem Umbenennen geschrieben.
42 Wird 'size_to_break' angegeben und ist dies > 0, wird dieser Wert (in
43 Bytes) statt der 50000 Bytes zum Rotieren des Logfiles benutzt.
44
45BEISPIELE
46---------
Zesstra1cd2f9e2018-09-05 17:01:41 +020047
48.. code-block:: pike
Zesstra18626972017-01-31 10:38:27 +010049
50 log_file( "report/wargon.rep", "TYPO von bla in blubb:\ntest\n");
51 In /log/report/wargon.rep finde ich nun die neueste Typomeldung... ;)
52 log_file( "/log/report/wargon.rep", "TYPO von bla in blubb:\ntest\n");
53 Gleiches Ergebnis. ;-)
54
55SIEHE AUCH
56----------
Zesstra18626972017-01-31 10:38:27 +010057
58 write_file(E)
59
Zesstra1cd2f9e2018-09-05 17:01:41 +02006005.09.2018, Zesstra
Zesstra18626972017-01-31 10:38:27 +010061