konto_check 0.0.2 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
data/CHANGES ADDED
@@ -0,0 +1,21 @@
1
+ important changes in version 0.2.0:
2
+ - many more functions added
3
+ - documentation in rdoc and HTML format
4
+ - the underlying C library is now version 4.0, see changes there.
5
+
6
+ important changes in version 0.0.3:
7
+
8
+ - Function konto_check: the order of parameters changed:
9
+ konto_check(blz,kto) instead of konto_check(kto,blz)
10
+
11
+ - The function load_bank_data will go away; instead a new function
12
+ konto_check::init() is provided which reads directly a lut file.
13
+ This function is much faster (about 7..25 times, depending on the
14
+ blocks to load) and has some more advantages.
15
+
16
+ - This version can be compiled for Ruby 1.8 and 1.9
17
+
18
+ - some new functions give access to all fields of the bank file:
19
+ bank_{name|name_kurz|plz|ort|pan|bic|nr|pz|aenderung|loeschung|nachfolge_blz}()
20
+
21
+ - for documentation, RTFS. Later some more documentation will be added ;-)
@@ -1,6 +1,7 @@
1
1
  h1. KontoCheck
2
2
 
3
- Check whether a certain bic/account-no-combination can possibly be valid for a German bank.
3
+ Check whether a certain bic/account-no-combination can possibly be valid for a German bank,
4
+ retrieve certain infos from the blz file and search for banks matching different criteria.
4
5
 
5
6
  It uses the C library konto_check (see http://sourceforge.net/projects/kontocheck/) by
6
7
  Michael Plugge.
@@ -13,41 +14,617 @@ An example tends to tell more than a 1000 words:
13
14
  >> require "konto_check"
14
15
  true
15
16
 
16
- >> KontoCheck::load_bank_data("./BLZ_20100308.txt")
17
+ >> KontoCheck::init()
17
18
  true
18
19
 
19
- >> KontoCheck::konto_check("52001","52250030")
20
+ # konto_check?(blz, ktno) => true/false (valid/invalid)
21
+ >> KontoCheck::konto_check?("52250030", "52001")
20
22
  true
21
23
 
22
- >> KontoCheck::bank_name("52250030")
23
- "hahaa!"
24
- (Wutt??? Doesn't work yet. Obviously)
24
+ >> KontoCheck::konto_check?("52250030", "52002")
25
+ false
26
+
27
+ # ISO-8859-1 encoded name of bank
28
+ >> KontoCheck::bank_name("10010010")
29
+ "Postbank"
30
+
31
+ # there is much more, RTFS or wait for/help creating more examples...
25
32
  </pre>
26
33
 
27
34
  h2. Short 'Documentation'
28
35
 
29
- h3. <tt>KontoCheck::konto_check(&lt;kto&gt;, &lt;blz&gt;)</tt>
36
+ h3. <tt>KontoCheck::konto_check?(&lt;blz&gt;, &lt;kto&gt;)</tt>
30
37
 
31
- check whether the given account number <tt>kto</tt> ca possibly be
38
+ check whether the given account number <tt>kto</tt> can possibly be
32
39
  a valid number of the bank with the bic <tt>blz</tt>.
33
40
 
34
- h3. <tt>KontoCheck::load_bank_data(&lt;datafile&gt;)</tt>
41
+ h3. <tt>KontoCheck::init(&lt;lut_file&gt;)</tt>
42
+
43
+ initialize the underlying C library konto_check with bank
44
+ information from the LUT file <tt>lut_file</tt>.
45
+ The LUT file can be created from the plain text file
46
+ found at: http://www.bundesbank.de/zahlungsverkehr/zahlungsverkehr_bankleitzahlen_download.php
47
+ This file is updated every three months, so be sure to
48
+ replace (and regenerate) it regularly.
49
+
50
+ There will be a rake task to update the LUT file soon.
51
+
52
+ h3. <tt>KontoCheck::bank_name(&lt;blz&gt;)</tt>
53
+
54
+ returns the name of the bank as a (ISO-8859-1 encoded)
55
+ string or raises a runtime error with a short error message
56
+ if an error occurred (invalid blz, blz too short, etc.).
57
+ This may be changed in the future to simply return nil (should be discussed).
58
+
59
+
60
+ h3. <tt>KontoCheck::konto_check_pz(&lt;pz&gt;, &lt;kto&gt;)</tt>
61
+
62
+ Check whether the given account number kto kann possibly be
63
+ a valid number of a bank with the given check method pz.
64
+
65
+ Possible return values (and short description):
66
+
67
+ -69 (MISSING_PARAMETER) "bei der Kontopr�fung fehlt ein notwendiger Parameter (BLZ oder Konto)"
68
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
69
+
70
+ -77 (BAV_FALSE) "BAV denkt, das Konto ist falsch (konto_check h�lt es f�r richtig)"
71
+ -29 (UNDEFINED_SUBMETHOD) "die (Unter)Methode ist nicht definiert"
72
+ -12 (INVALID_KTO_LENGTH) "ein Konto mu� zwischen 1 und 10 Stellen haben"
73
+ -3 (INVALID_KTO) "das Konto ist ung�ltig"
74
+ -2 (NOT_IMPLEMENTED) "die Methode wurde noch nicht implementiert"
75
+ -1 (NOT_DEFINED) "die Methode ist nicht definiert"
76
+ 0 (FALSE) "falsch"
77
+ 1 (OK) "ok"
78
+ 2 (OK_NO_CHK) "ok, ohne Pr�fung"
79
+
80
+
81
+ h3. <tt>KontoCheck::konto_check(&lt;blz&gt;, &lt;kto&gt;)</tt>
82
+
83
+ Check whether the given account number kto kann possibly be
84
+ a valid number of the bank with the bic blz.
85
+
86
+ Possible return values (and short description):
87
+
88
+ -69 (MISSING_PARAMETER) "Bei der Kontopr�fung fehlt ein notwendiger Parameter (BLZ oder Konto)"
89
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
90
+
91
+ -77 (BAV_FALSE) "BAV denkt, das Konto ist falsch (konto_check h�lt es f�r richtig)"
92
+ -29 (UNDEFINED_SUBMETHOD) "Die (Unter)Methode ist nicht definiert"
93
+ -12 (INVALID_KTO_LENGTH) "ein Konto mu� zwischen 1 und 10 Stellen haben"
94
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
95
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
96
+ -3 (INVALID_KTO) "das Konto ist ung�ltig"
97
+ -2 (NOT_IMPLEMENTED) "die Methode wurde noch nicht implementiert"
98
+ -1 (NOT_DEFINED) "die Methode ist nicht definiert"
99
+ 0 (FALSE) "falsch"
100
+ 1 (OK) "ok"
101
+ 2 (OK_NO_CHK) "ok, ohne Pr�fung"
102
+
103
+
104
+ h3. <tt>KontoCheck::init(&lt;level&gt;[,&lt;lutfile&gt;[,&lt;set&gt;]]])</tt>
105
+
106
+ ATTENTION - the order of the parameters changed: ***
107
+ first comes now the initialization level, then the filename and ***
108
+ last the set. This change was introduced because the filename can be found ***
109
+ usually in the default values. ***
110
+
35
111
 
36
112
  initialize the underlying C library konto_check with the bank
37
- information from the file <tt>datafile</tt>.
113
+ information from lutfile.
114
+
115
+ Possible return values (and short description):
116
+
117
+ -112 (KTO_CHECK_UNSUPPORTED_COMPRESSION) "die notwendige Kompressions-Bibliothek wurden beim Kompilieren nicht eingebunden"
118
+ -64 (INIT_FATAL_ERROR) "Initialisierung fehlgeschlagen (init_wait geblockt)"
119
+ -63 (INCREMENTAL_INIT_NEEDS_INFO) "Ein inkrementelles Initialisieren ben�tigt einen Info-Block in der LUT-Datei"
120
+ -62 (INCREMENTAL_INIT_FROM_DIFFERENT_FILE) "Ein inkrementelles Initialisieren mit einer anderen LUT-Datei ist nicht m�glich"
121
+ -36 (LUT2_Z_MEM_ERROR) "Memory error in den ZLIB-Routinen"
122
+ -35 (LUT2_Z_DATA_ERROR) "Datenfehler im komprimierten LUT-Block"
123
+ -34 (LUT2_BLOCK_NOT_IN_FILE) "Der Block ist nicht in der LUT-Datei enthalten"
124
+ -33 (LUT2_DECOMPRESS_ERROR) "Fehler beim Dekomprimieren eines LUT-Blocks"
125
+ -31 (LUT2_FILE_CORRUPTED) "Die LUT-Datei ist korrumpiert"
126
+ -20 (LUT_CRC_ERROR) "Pr�fsummenfehler in der blz.lut Datei"
127
+ -10 (FILE_READ_ERROR) "kann Datei nicht lesen"
128
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
129
+ -7 (INVALID_LUT_FILE) "die blz.lut Datei ist inkosistent/ung�ltig"
130
+ -6 (NO_LUT_FILE) "die blz.lut Datei wurde nicht gefunden"
131
+
132
+ 6 (LUT1_SET_LOADED) "Die Datei ist im alten LUT-Format (1.0/1.1)"
133
+ 1 (OK) "ok"
134
+
135
+
136
+ h3. <tt>KontoCheck::free()</tt>
137
+
138
+ Release allocated memory of the underlying C library konto_check
139
+ return value is always true
140
+
141
+
142
+ h3. <tt>KontoCheck::generate_lutfile(&lt;inputfile&gt;, &lt;outputfile&gt;[, &lt;user_info&gt;[, &lt;gueltigkeit&gt;[,</tt>
143
+
144
+ <felder>[, <filialen>[, <set>]]]]])
145
+
146
+ generate a new lutfile
147
+
148
+ Possible return values (and short description):
149
+ -112 (KTO_CHECK_UNSUPPORTED_COMPRESSION) "die notwendige Kompressions-Bibliothek wurden beim Kompilieren nicht eingebunden"
150
+ -57 (LUT2_GUELTIGKEIT_SWAPPED) "Im G�ltigkeitsdatum sind Anfangs- und Enddatum vertauscht"
151
+ -56 (LUT2_INVALID_GUELTIGKEIT) "Das angegebene G�ltigkeitsdatum ist ung�ltig (Soll: JJJJMMTT-JJJJMMTT)"
152
+ -32 (LUT2_COMPRESS_ERROR) "Fehler beim Komprimieren eines LUT-Blocks"
153
+ -31 (LUT2_FILE_CORRUPTED) "Die LUT-Datei ist korrumpiert"
154
+ -30 (LUT2_NO_SLOT_FREE) "Im Inhaltsverzeichnis der LUT-Datei ist kein Slot mehr frei"
155
+ -15 (INVALID_BLZ_FILE) "Fehler in der blz.txt Datei (falsche Zeilenl�nge)"
156
+ -11 (FILE_WRITE_ERROR) "kann Datei nicht schreiben"
157
+ -10 (FILE_READ_ERROR) "kann Datei nicht lesen"
158
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
159
+ -7 (INVALID_LUT_FILE) "die blz.lut Datei ist inkosistent/ung�ltig"
160
+
161
+ 1 (OK) "ok"
162
+ 7 (LUT1_FILE_GENERATED) "ok; es wurde allerdings eine LUT-Datei im alten Format (1.0/1.1) generiert"
163
+
164
+
165
+
166
+ h3. <tt>KontoCheck::retval2txt(&lt;retval&gt;)</tt>
167
+
168
+ Convert a numeric retval to an ISO8859-1 encoded string.
169
+
170
+
171
+ h3. <tt>KontoCheck::retval2txt_short(&lt;retval&gt;)</tt>
172
+
173
+ Convert a numeric retval to a short string (macro name).
174
+
175
+
176
+ h3. <tt>KontoCheck::retval2utf(&lt;retval&gt;)</tt>
177
+
178
+ Convert a numeric retval to an UTF-8 encoded string.
179
+
180
+
181
+ h3. <tt>KontoCheck::retval2html(&lt;retval&gt;)</tt>
182
+
183
+ Convert a numeric retval to a string with HTML entities for german Umlaute.
184
+
185
+
186
+ h3. <tt>KontoCheck::dump_lutfile(&lt;lutfile&gt;)</tt>
187
+
188
+ Get all infos about the contents of a lutfile
189
+
190
+
38
191
 
39
- Internally, this file is first transformed into a LUT file and then
40
- read.
192
+ h3. <tt>KontoCheck::lut_info([lutfile])</tt>
41
193
 
42
- For the datafile, use the file '<tt>blz_yyyymmdd.txt</tt>' from
194
+ Get infos about the contents of a lutfile or about the loaded blocks (if called without filename).
195
+
196
+ The return value is an array of 5 elements:
197
+
198
+ retval: overall return status
199
+ valid1: validity of first block
200
+ valid2: validity of second block
201
+ info1: first infoblock
202
+ info2: second infoblock
203
+
204
+ Possible return value for info1 and info2 with short description:
205
+
206
+ -105 (LUT2_NO_LONGER_VALID_BETTER) "Beide Datens�tze sind nicht mehr g�ltig; dieser ist aber j�nger als der andere"
207
+ -59 (LUT2_NOT_YET_VALID) "Der Datenblock ist noch nicht g�ltig"
208
+ -58 (LUT2_NO_LONGER_VALID) "Der Datenblock ist nicht mehr g�ltig"
209
+ -34 (LUT2_BLOCK_NOT_IN_FILE) "Die LUT-Datei enth�lt den Infoblock nicht"
210
+ 4 (LUT2_VALID) "Der Datenblock ist aktuell g�ltig"
211
+ 5 (LUT2_NO_VALID_DATE) "Der Datenblock enth�lt kein G�ltigkeitsdatum"
212
+
213
+ Possible return value for retval (and short description):
214
+
215
+ -112 (KTO_CHECK_UNSUPPORTED_COMPRESSION) "die notwendige Kompressions-Bibliothek wurden beim Kompilieren nicht eingebunden"
216
+ -70 (LUT1_FILE_USED) "Es wurde eine LUT-Datei im Format 1.0/1.1 geladen"
217
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
218
+ -37 (LUT2_Z_BUF_ERROR) "Buffer error in den ZLIB Routinen"
219
+ -36 (LUT2_Z_MEM_ERROR) "Memory error in den ZLIB-Routinen"
220
+ -35 (LUT2_Z_DATA_ERROR) "Datenfehler im komprimierten LUT-Block"
221
+ -34 (LUT2_BLOCK_NOT_IN_FILE) "Der Block ist nicht in der LUT-Datei enthalten"
222
+ -31 (LUT2_FILE_CORRUPTED) "Die LUT-Datei ist korrumpiert"
223
+ -20 (LUT_CRC_ERROR) "Pr�fsummenfehler in der blz.lut Datei"
224
+ -10 (FILE_READ_ERROR) "kann Datei nicht lesen"
225
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
226
+ -7 (INVALID_LUT_FILE) "die blz.lut Datei ist inkosistent/ung�ltig"
227
+ 1 (OK) "ok"
228
+
229
+
230
+
231
+ h3. <tt>KontoCheck::load_bank_data(&lt;datafile&gt;)</tt>
232
+
233
+ This function was the old initialization function for konto_check; it is now
234
+ replaced by init() for initialization and generate_lutfile() for generating
235
+ a data file with all bank informations from blz_yyyymmdd.txt from
43
236
  http://www.bundesbank.de/zahlungsverkehr/zahlungsverkehr_bankleitzahlen_download.php
44
- These files are updated every three months, so be sure to
45
- replace them regularly.
46
237
 
47
- h3. <tt>KontoCheck::bank_name(&lt;blz&gt;)</tt>
238
+ This function serves now only as a schibbolet to check if someone uses the
239
+ old interface :-).
240
+
241
+ WARNING - this function will be removed in near future. Use KontoCheck::init()
242
+ for initialization from a lutfile, KontoCheck::generate_lutfile() to generate a
243
+ new lutfile. The init() function is much faster (about 7..20 times) and has
244
+ some more advantages (two sets of data, flexible level of initialization,
245
+ compact format).
246
+
247
+
248
+ h3. <tt>KontoCheck::iban_2bic(&lt;blz&gt;)</tt>
249
+
250
+ Determine the BIC for a given (german) IBAN
251
+
252
+ Possible return values for retval (and short description):
253
+
254
+ -68 (IBAN2BIC_ONLY_GERMAN) "Die Funktion iban2bic() arbeitet nur mit deutschen Bankleitzahlen"
255
+ -46 (LUT2_BIC_NOT_INITIALIZED) "Das Feld BIC wurde nicht initialisiert"
256
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
257
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
258
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
259
+ 1 (OK) "ok"
260
+
261
+
262
+ h3. <tt>KontoCheck::iban_check(&lt;blz&gt;)</tt>
263
+
264
+ Test an IBAN
265
+
266
+ Possible return values for retval (and short description):
267
+
268
+ -74 (NO_GERMAN_BIC) "Ein Konto kann kann nur f�r deutsche Banken gepr�ft werden"
269
+ -67 (IBAN_OK_KTO_NOT) "Die Pr�fziffer der IBAN stimmt, die der Kontonummer nicht"
270
+ -66 (KTO_OK_IBAN_NOT) "Die Pr�fziffer der Kontonummer stimmt, die der IBAN nicht"
271
+ 0 (FALSE) "falsch"
272
+ 1 (OK) "ok"
273
+
274
+ Possible return values for retval_kc:
275
+ -77 (BAV_FALSE) "BAV denkt, das Konto ist falsch (konto_check h�lt es f�r richtig)"
276
+ -69 (MISSING_PARAMETER) "Bei der Kontopr�fung fehlt ein notwendiger Parameter (BLZ oder Konto)"
277
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
278
+ -29 (UNDEFINED_SUBMETHOD) "Die (Unter)Methode ist nicht definiert"
279
+ -12 (INVALID_KTO_LENGTH) "ein Konto mu� zwischen 1 und 10 Stellen haben"
280
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
281
+ -4 (INVALID_BLZ) "Die (Unter)Methode ist nicht definiert"
282
+ -3 (INVALID_KTO) "das Konto ist ung�ltig"
283
+ -2 (NOT_IMPLEMENTED) "die Methode wurde noch nicht implementiert"
284
+ -1 (NOT_DEFINED) "die Methode ist nicht definiert"
285
+ 0 (FALSE) "falsch"
286
+ 1 (OK) "ok"
287
+ 2 (OK_NO_CHK) "ok, ohne Pr�fung"
288
+
289
+
290
+
291
+ h3. <tt>KontoCheck::ipi_gen(&lt;zweck&gt;)</tt>
292
+
293
+ Determine the BIC for a given (german) IBAN
294
+
295
+ Possible return values for retval (and short description):
296
+
297
+ -72 (IPI_INVALID_CHARACTER) "Im strukturierten Verwendungszweck d�rfen nur alphanumerische Zeichen vorkommen"
298
+ -71 (IPI_INVALID_LENGTH) "Die L�nge des IPI-Verwendungszwecks darf maximal 18 Byte sein"
299
+ 1 (OK) "ok"
300
+
301
+
302
+
303
+ h3. <tt>KontoCheck::ipi_check(&lt;zweck&gt;)</tt>
304
+
305
+ Determine the BIC for a given (german) IBAN
306
+
307
+ Possible return values for retval (and short description):
308
+
309
+ -73 (IPI_CHECK_INVALID_LENGTH) "Der zu validierende strukturierete Verwendungszweck mu� genau 20 Zeichen enthalten"
310
+ 0 (FALSE) "falsch"
311
+ 1 (OK) "ok"
312
+
313
+
314
+ h3. <tt>KontoCheck::bank_valid(&lt;blz&gt; [,filiale])</tt>
315
+
316
+ Check if a given blz is valid
317
+
318
+ Possible return values (and short description):
319
+
320
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
321
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
322
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
323
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
324
+ 1 (OK) "ok"
325
+
326
+
327
+ h3. <tt>KontoCheck::bank_filialen(&lt;blz&gt;)</tt>
328
+
329
+ Return the number of branch offices
330
+
331
+ Possible return values (and short description):
332
+
333
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
334
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
335
+ -52 (LUT2_FILIALEN_NOT_INITIALIZED) "Das Feld Filialen wurde nicht initialisiert"
336
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
337
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
338
+ 1 (OK) "ok"
339
+
340
+
341
+
342
+ h3. <tt>KontoCheck::bank_alles(&lt;blz&gt; [,filiale])</tt>
343
+
344
+ Return all available information about a bank
345
+
346
+ Possible return values (and short description):
347
+
348
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
349
+ -38 (LUT2_PARTIAL_OK) "es wurden nicht alle Blocks geladen"
350
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
351
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
352
+ 1 (OK) "ok"
353
+
354
+
355
+
356
+ h3. <tt>KontoCheck::bank_name(&lt;blz&gt; [,filiale])</tt>
357
+
358
+ Return the name of a bank
359
+
360
+ Possible return values (and short description):
361
+
362
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
363
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
364
+ -51 (LUT2_NAME_NOT_INITIALIZED) "Das Feld Bankname wurde nicht initialisiert"
365
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
366
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
367
+ 1 (OK) "ok"
368
+
369
+
370
+ h3. <tt>KontoCheck::bank_name_kurz(&lt;blz&gt; [,filiale])</tt>
371
+
372
+ Return the short name of a bank
373
+
374
+ Possible return values (and short description):
375
+
376
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
377
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
378
+ -48 (LUT2_NAME_KURZ_NOT_INITIALIZED) "Das Feld Kurzname wurde nicht initialisiert"
379
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
380
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
381
+ 1 (OK) "ok"
382
+
383
+
384
+ h3. <tt>KontoCheck::bank_ort(&lt;blz&gt; [,filiale])</tt>
385
+
386
+ Return the location of a bank
387
+
388
+ Possible return values (and short description):
389
+
390
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
391
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
392
+ -49 (LUT2_ORT_NOT_INITIALIZED) "Das Feld Ort wurde nicht initialisiert"
393
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
394
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
395
+ 1 (OK) "ok"
396
+
397
+
398
+
399
+ h3. <tt>KontoCheck::bank_plz(&lt;blz&gt; [,filiale])</tt>
400
+
401
+ Return the plz of a bank
402
+
403
+ Possible return values (and short description):
404
+
405
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
406
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
407
+ -50 (LUT2_PLZ_NOT_INITIALIZED) "Das Feld PLZ wurde nicht initialisiert"
408
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
409
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
410
+ 1 (OK) "ok"
411
+
412
+
413
+ h3. <tt>KontoCheck::bank_pz(&lt;blz&gt; [,filiale])</tt>
414
+
415
+ Return the check method of a bank
416
+
417
+ Possible return values (and short description):
418
+
419
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
420
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
421
+ -45 (LUT2_PZ_NOT_INITIALIZED) "Das Feld Pr�fziffer wurde nicht initialisiert"
422
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
423
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
424
+ 1 (OK) "ok"
425
+
426
+
427
+
428
+ h3. <tt>KontoCheck::bank_bic(&lt;blz&gt; [,filiale])</tt>
429
+
430
+ Return the BIC (Bank Identifier Code) of a bank
431
+
432
+ Possible return values (and short description):
433
+
434
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
435
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
436
+ -46 (LUT2_BIC_NOT_INITIALIZED) "Das Feld BIC wurde nicht initialisiert"
437
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
438
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
439
+ 1 (OK) "ok"
440
+
441
+
442
+
443
+ h3. <tt>KontoCheck::bank_aenderung(&lt;blz&gt; [,filiale])</tt>
444
+
445
+ Return the '�nderung' flag of a bank (as string):
446
+ A Addition, M Modified, U Unchanged, D Deletion.
447
+
448
+ Possible return values (and short description):
449
+
450
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
451
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
452
+ -43 (LUT2_AENDERUNG_NOT_INITIALIZED) "Das Feld �nderung wurde nicht initialisiert"
453
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
454
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
455
+ 1 (OK) "ok"
456
+
457
+
458
+
459
+ h3. <tt>KontoCheck::bank_loeschung(&lt;blz&gt; [,filiale])</tt>
460
+
461
+ Return the 'L�schung' flag of a bank as int: 0 or 1
462
+
463
+ Possible return values (and short description):
464
+
465
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
466
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
467
+ -42 (LUT2_LOESCHUNG_NOT_INITIALIZED) "Das Feld L�schung wurde nicht initialisiert"
468
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
469
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
470
+ 1 (OK) "ok"
471
+
472
+
473
+
474
+ h3. <tt>KontoCheck::bank_nachfolge_blz(&lt;blz&gt; [,filiale])</tt>
475
+
476
+ Return the successor of a bank which will be deleted ('L�schung' flag set)
477
+
478
+ Possible return values (and short description):
479
+
480
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
481
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
482
+ -41 (LUT2_NACHFOLGE_BLZ_NOT_INITIALIZED) "Das Feld Nachfolge-BLZ wurde nicht initialisiert"
483
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
484
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
485
+ 1 (OK) "ok"
486
+
487
+
488
+
489
+ h3. <tt>KontoCheck::bank_pan(&lt;blz&gt; [,filiale])</tt>
490
+
491
+ Return the PAN (Primary Account Number) of a bank
492
+
493
+ Possible return values (and short description):
494
+
495
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
496
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
497
+ -47 (LUT2_PAN_NOT_INITIALIZED) "Das Feld PAN wurde nicht initialisiert"
498
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
499
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
500
+ 1 (OK) "ok"
501
+
502
+
503
+
504
+ h3. <tt>KontoCheck::bank_nr(&lt;blz&gt; [,filiale])</tt>
505
+
506
+ Return the sequence number of a bank (internal field of BLZ file)
507
+
508
+ Possible return values (and short description):
509
+
510
+ -55 (LUT2_INDEX_OUT_OF_RANGE) "Der Index f�r die Filiale ist ung�ltig"
511
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
512
+ -44 (LUT2_NR_NOT_INITIALIZED) "Das Feld NR wurde nicht initialisiert"
513
+ -5 (INVALID_BLZ_LENGTH) "die Bankleitzahl ist nicht achtstellig"
514
+ -4 (INVALID_BLZ) "die Bankleitzahl ist ung�ltig"
515
+ 1 (OK) "ok"
516
+
517
+
518
+
519
+ h3. <tt>KontoCheck::bank_suche_bic(&lt;search_bic&gt;)</tt>
520
+
521
+ Find all banks with a given bic
522
+
523
+ Possible return values (and short description):
524
+
525
+ -78 (KEY_NOT_FOUND) "Die Suche lieferte kein Ergebnis"
526
+ -70 (LUT1_FILE_USED) "Es wurde eine LUT-Datei im Format 1.0/1.1 geladen"
527
+ -46 (LUT2_BIC_NOT_INITIALIZED) "Das Feld BIC wurde nicht initialisiert"
528
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
529
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
530
+ 1 (OK) "ok"
531
+
532
+
533
+
534
+ h3. <tt>KontoCheck::bank_suche_namen(&lt;name&gt;)</tt>
535
+
536
+ Find all banks with a given name
537
+
538
+ Possible return values (and short description):
539
+
540
+ -78 (KEY_NOT_FOUND) "Die Suche lieferte kein Ergebnis"
541
+ -70 (LUT1_FILE_USED) "Es wurde eine LUT-Datei im Format 1.0/1.1 geladen"
542
+ -51 (LUT2_NAME_NOT_INITIALIZED) "Das Feld Bankname wurde nicht initialisiert"
543
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
544
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
545
+ 1 (OK) "ok"
546
+
547
+
548
+
549
+ h3. <tt>KontoCheck::bank_suche_namen_kurz(&lt;short_name&gt;)</tt>
550
+
551
+ Find all banks with a given short name
552
+
553
+ Possible return values (and short description):
554
+
555
+ -78 (KEY_NOT_FOUND) "Die Suche lieferte kein Ergebnis"
556
+ -70 (LUT1_FILE_USED) "Es wurde eine LUT-Datei im Format 1.0/1.1 geladen"
557
+ -48 (LUT2_NAME_KURZ_NOT_INITIALIZED) "Das Feld Kurzname wurde nicht initialisiert"
558
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
559
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
560
+ 1 (OK) "ok"
561
+
562
+
563
+
564
+ h3. <tt>KontoCheck::bank_suche_plz(&lt;plz1&gt;[, plz2])</tt>
565
+
566
+ Find all banks with plz between plz1 and plz2
567
+
568
+ Possible return values (and short description):
569
+
570
+ -78 (KEY_NOT_FOUND) "Die Suche lieferte kein Ergebnis"
571
+ -70 (LUT1_FILE_USED) "Es wurde eine LUT-Datei im Format 1.0/1.1 geladen"
572
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
573
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
574
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
575
+ 1 (OK) "ok"
576
+
577
+
578
+
579
+ h3. <tt>KontoCheck::bank_suche_pz(&lt;pz1&gt;[, pz2])</tt>
580
+
581
+ Find all banks with check method between pz1 and pz2
582
+
583
+ Possible return values (and short description):
584
+
585
+ -78 (KEY_NOT_FOUND) "Die Suche lieferte kein Ergebnis"
586
+ -70 (LUT1_FILE_USED) "Es wurde eine LUT-Datei im Format 1.0/1.1 geladen"
587
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
588
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
589
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
590
+ 1 (OK) "ok"
591
+
592
+
593
+
594
+ h3. <tt>KontoCheck::bank_suche_blz(&lt;blz1&gt;[, blz2])</tt>
595
+
596
+ Find all banks with bic between blz1 and blz2
597
+
598
+ Possible return values (and short description):
599
+
600
+ -78 (KEY_NOT_FOUND) "Die Suche lieferte kein Ergebnis"
601
+ -70 (LUT1_FILE_USED) "Es wurde eine LUT-Datei im Format 1.0/1.1 geladen"
602
+ -53 (LUT2_BLZ_NOT_INITIALIZED) "Das Feld BLZ wurde nicht initialisiert"
603
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
604
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
605
+ 1 (OK) "ok"
606
+
607
+
608
+
609
+ h3. <tt>KontoCheck::bank_suche_ort(&lt;suchort&gt;)</tt>
610
+
611
+ Find all banks in a given location
612
+
613
+ Possible return values (and short description):
614
+
615
+ -78 (KEY_NOT_FOUND) "Die Suche lieferte kein Ergebnis"
616
+ -70 (LUT1_FILE_USED) "Es wurde eine LUT-Datei im Format 1.0/1.1 geladen"
617
+ -49 (LUT2_ORT_NOT_INITIALIZED) "Das Feld Ort wurde nicht initialisiert"
618
+ -40 (LUT2_NOT_INITIALIZED) "die Programmbibliothek wurde noch nicht initialisiert"
619
+ -9 (ERROR_MALLOC) "kann keinen Speicher allokieren"
620
+ 1 (OK) "ok"
621
+
622
+
623
+ h3. <tt>KontoCheck::version()</tt>
624
+
625
+ Get the version string for konto_check
626
+
48
627
 
49
- gives the name of the bank as a string or nil
50
- if no bank with the given bic <tt>blz</tt> exists.
51
628
 
52
629
  h2. License
53
630