/ Aminet 18 / aminetcdnumber181997.iso / Aminet / misc / emu / AROSdev.lha / AROS / docs / src / devinfo-5.src / node4_ct.html

< prev

next >

MacOS 8.1

Win98

DOS

browse contents

view JSON data

view as text

+--------+-------------------------+-------------------------+--------+--------+
|00000000| 3c 21 44 4f 43 54 59 50 | 45 20 48 54 4d 4c 20 50 |<!DOCTYP|E HTML P|
|00000010| 55 42 4c 49 43 20 22 2d | 2f 2f 57 33 43 2f 2f 44 |UBLIC "-|//W3C//D|
|00000020| 54 44 20 48 54 4d 4c 20 | 33 2e 32 20 46 69 6e 61 |TD HTML |3.2 Fina|
|00000030| 6c 2f 2f 65 6e 22 3e 0a | 0a 3c 21 2d 2d 43 6f 6e |l//en">.|.<!--Con|
|00000040| 76 65 72 74 65 64 20 77 | 69 74 68 20 4c 61 54 65 |verted w|ith LaTe|
|00000050| 58 32 48 54 4d 4c 20 32 | 30 32 32 20 28 52 65 6c |X2HTML 2|022 (Rel|
|00000060| 65 61 73 65 64 20 4a 61 | 6e 75 61 72 79 20 31 2c |eased Ja|nuary 1,|
|00000070| 20 32 30 32 32 29 20 2d | 2d 3e 0a 3c 48 54 4d 4c | 2022) -|->.<HTML|
|00000080| 20 6c 61 6e 67 3d 22 65 | 6e 22 3e 0a 3c 48 45 41 | lang="e|n">.<HEA|
|00000090| 44 3e 0a 3c 54 49 54 4c | 45 3e 43 6f 6e 74 65 6e |D>.<TITL|E>Conten|
|000000a0| 74 73 20 6f 66 20 46 75 | 6e 63 74 69 6f 6e 20 70 |ts of Fu|nction p|
|000000b0| 72 6f 74 6f 74 79 70 65 | 73 20 61 6e 64 20 68 65 |rototype|s and he|
|000000c0| 61 64 65 72 73 3c 2f 54 | 49 54 4c 45 3e 0a 0a 3c |aders</T|ITLE>..<|
|000000d0| 4d 45 54 41 20 48 54 54 | 50 2d 45 51 55 49 56 3d |META HTT|P-EQUIV=|
|000000e0| 22 43 6f 6e 74 65 6e 74 | 2d 54 79 70 65 22 20 43 |"Content|-Type" C|
|000000f0| 4f 4e 54 45 4e 54 3d 22 | 74 65 78 74 2f 68 74 6d |ONTENT="|text/htm|
|00000100| 6c 3b 20 63 68 61 72 73 | 65 74 3d 75 74 66 2d 38 |l; chars|et=utf-8|
|00000110| 22 3e 0a 3c 4d 45 54 41 | 20 4e 41 4d 45 3d 22 76 |">.<META| NAME="v|
|00000120| 69 65 77 70 6f 72 74 22 | 20 43 4f 4e 54 45 4e 54 |iewport"| CONTENT|
|00000130| 3d 22 77 69 64 74 68 3d | 64 65 76 69 63 65 2d 77 |="width=|device-w|
|00000140| 69 64 74 68 2c 20 69 6e | 69 74 69 61 6c 2d 73 63 |idth, in|itial-sc|
|00000150| 61 6c 65 3d 31 2e 30 22 | 3e 0a 3c 4d 45 54 41 20 |ale=1.0"|>.<META |
|00000160| 4e 41 4d 45 3d 22 47 65 | 6e 65 72 61 74 6f 72 22 |NAME="Ge|nerator"|
|00000170| 20 43 4f 4e 54 45 4e 54 | 3d 22 4c 61 54 65 58 32 | CONTENT|="LaTeX2|
|00000180| 48 54 4d 4c 20 76 32 30 | 32 32 22 3e 0a 0a 3c 4c |HTML v20|22">..<L|
|00000190| 49 4e 4b 20 52 45 4c 3d | 22 53 54 59 4c 45 53 48 |INK REL=|"STYLESH|
|000001a0| 45 45 54 22 20 48 52 45 | 46 3d 22 64 65 76 69 6e |EET" HRE|F="devin|
|000001b0| 66 6f 2d 35 2e 63 73 73 | 22 3e 0a 0a 3c 4c 49 4e |fo-5.css|">..<LIN|
|000001c0| 4b 20 52 45 4c 3d 22 6e | 65 78 74 22 20 48 52 45 |K REL="n|ext" HRE|
|000001d0| 46 3d 22 6e 6f 64 65 35 | 5f 6d 6e 2e 68 74 6d 6c |F="node5|_mn.html|
|000001e0| 22 3e 0a 3c 4c 49 4e 4b | 20 52 45 4c 3d 22 70 72 |">.<LINK| REL="pr|
|000001f0| 65 76 69 6f 75 73 22 20 | 48 52 45 46 3d 22 6e 6f |evious" |HREF="no|
|00000200| 64 65 33 5f 6d 6e 2e 68 | 74 6d 6c 22 3e 0a 3c 4c |de3_mn.h|tml">.<L|
|00000210| 49 4e 4b 20 52 45 4c 3d | 22 75 70 22 20 48 52 45 |INK REL=|"up" HRE|
|00000220| 46 3d 22 6e 6f 64 65 31 | 5f 6d 6e 2e 68 74 6d 6c |F="node1|_mn.html|
|00000230| 22 3e 0a 3c 4c 49 4e 4b | 20 52 45 4c 3d 22 6e 65 |">.<LINK| REL="ne|
|00000240| 78 74 22 20 48 52 45 46 | 3d 22 6e 6f 64 65 35 5f |xt" HREF|="node5_|
|00000250| 6d 6e 2e 68 74 6d 6c 22 | 3e 0a 3c 2f 48 45 41 44 |mn.html"|>.</HEAD|
|00000260| 3e 0a 20 0a 3c 42 4f 44 | 59 20 62 67 63 6f 6c 6f |>. .<BOD|Y bgcolo|
|00000270| 72 3d 22 23 66 66 66 66 | 66 66 22 20 74 65 78 74 |r="#ffff|ff" text|
|00000280| 3d 22 23 30 30 30 30 30 | 30 22 20 6c 69 6e 6b 3d |="#00000|0" link=|
|00000290| 22 23 39 39 34 34 45 45 | 22 20 76 6c 69 6e 6b 3d |"#9944EE|" vlink=|
|000002a0| 22 23 30 30 30 30 66 66 | 22 20 61 6c 69 6e 6b 3d |"#0000ff|" alink=|
|000002b0| 22 23 30 30 66 66 30 30 | 22 3e 0a 0a 3c 48 32 3e |"#00ff00|">..<H2>|
|000002c0| 3c 41 20 49 44 3d 22 53 | 45 43 54 49 4f 4e 30 30 |<A ID="S|ECTION00|
|000002d0| 30 31 33 30 30 30 30 30 | 30 30 30 30 30 30 30 30 |01300000|00000000|
|000002e0| 30 30 22 3e 0a 46 75 6e | 63 74 69 6f 6e 20 70 72 |00">.Fun|ction pr|
|000002f0| 6f 74 6f 74 79 70 65 73 | 20 61 6e 64 20 68 65 61 |ototypes| and hea|
|00000300| 64 65 72 73 3c 2f 41 3e | 0a 3c 2f 48 32 3e 0a 0a |ders</A>|.</H2>..|
|00000310| 3c 50 3e 0a 45 76 65 72 | 79 20 66 75 6e 63 74 69 |<P>.Ever|y functi|
|00000320| 6f 6e 20 69 6e 20 41 52 | 4f 53 20 6d 75 73 74 20 |on in AR|OS must |
|00000330| 68 61 76 65 20 61 20 66 | 75 6c 6c 20 41 4e 53 49 |have a f|ull ANSI|
|00000340| 20 43 20 70 72 6f 74 6f | 74 79 70 65 2e 20 50 72 | C proto|type. Pr|
|00000350| 6f 74 6f 74 79 70 65 73 | 20 73 68 6f 75 6c 64 0a |ototypes| should.|
|00000360| 62 65 20 63 6f 6c 6c 65 | 63 74 65 64 20 69 6e 20 |be colle|cted in |
|00000370| 69 6e 20 6f 6e 65 20 68 | 65 61 64 65 72 20 70 65 |in one h|eader pe|
|00000380| 72 20 66 69 6c 65 20 69 | 66 20 69 74 20 69 73 20 |r file i|f it is |
|00000390| 6e 65 65 64 65 64 20 62 | 79 20 6f 6e 6c 79 20 61 |needed b|y only a|
|000003a0| 20 66 65 77 20 66 69 6c | 65 73 0a 28 6e 6f 20 6e | few fil|es.(no n|
|000003b0| 65 65 64 20 74 6f 20 72 | 65 63 6f 6d 70 69 6c 65 |eed to r|ecompile|
|000003c0| 20 74 68 65 20 77 68 6f | 6c 65 20 70 72 6f 6a 65 | the who|le proje|
|000003d0| 63 74 20 69 66 20 79 6f | 75 20 63 68 61 6e 67 65 |ct if yo|u change|
|000003e0| 20 61 20 66 75 6e 63 74 | 69 6f 6e 20 77 68 69 63 | a funct|ion whic|
|000003f0| 68 20 75 73 65 64 0a 6f | 6e 6c 79 20 6f 6e 63 65 |h used.o|nly once|
|00000400| 29 2c 20 69 6e 20 6f 6e | 65 20 68 65 61 64 65 72 |), in on|e header|
|00000410| 20 70 65 72 20 64 69 72 | 65 63 74 6f 72 79 20 69 | per dir|ectory i|
|00000420| 66 20 69 74 27 73 20 61 | 20 63 6f 6d 6d 6f 6e 6c |f it's a| commonl|
|00000430| 79 20 75 73 65 64 20 66 | 75 6e 63 74 69 6f 6e 20 |y used f|unction |
|00000440| 69 6e 0a 74 68 61 74 20 | 64 69 72 65 63 74 6f 72 |in.that |director|
|00000450| 79 20 6f 72 20 69 6e 20 | 6f 6e 65 20 68 65 61 64 |y or in |one head|
|00000460| 65 72 20 70 65 72 20 6c | 6f 67 69 63 61 6c 20 67 |er per l|ogical g|
|00000470| 72 6f 75 70 20 28 69 65 | 2e 20 6f 6e 65 20 68 65 |roup (ie|. one he|
|00000480| 61 64 65 72 20 66 6f 72 | 20 61 6c 6c 0a 66 75 6e |ader for| all.fun|
|00000490| 63 74 69 6f 6e 73 20 69 | 6e 20 61 20 6c 69 62 72 |ctions i|n a libr|
|000004a0| 61 72 79 29 2e 0a 0a 3c | 50 3e 0a 54 68 65 20 66 |ary)...<|P>.The f|
|000004b0| 75 6e 63 74 69 6f 6e 20 | 68 65 61 64 65 72 20 28 |unction |header (|
|000004c0| 69 65 2e 20 74 68 65 20 | 63 6f 6d 6d 65 6e 74 20 |ie. the |comment |
|000004d0| 62 65 66 6f 72 65 20 74 | 68 65 20 66 75 6e 63 74 |before t|he funct|
|000004e0| 69 6f 6e 29 20 6d 75 73 | 74 20 62 65 20 6f 66 20 |ion) mus|t be of |
|000004f0| 61 0a 73 70 65 63 69 61 | 6c 20 66 6f 72 6d 61 74 |a.specia|l format|
|00000500| 20 62 65 63 61 75 73 65 | 20 74 68 65 20 41 75 74 | because| the Aut|
|00000510| 6f 44 6f 63 73 20 61 72 | 65 20 67 65 6e 65 72 61 |oDocs ar|e genera|
|00000520| 74 65 64 20 66 72 6f 6d | 20 69 74 2e 20 48 65 72 |ted from| it. Her|
|00000530| 65 20 69 73 20 61 6e 0a | 65 78 61 6d 70 6c 65 20 |e is an.|example |
|00000540| 66 6f 72 20 69 74 20 28 | 66 72 6f 6d 20 41 52 4f |for it (|from ARO|
|00000550| 53 2f 65 78 65 63 2f 61 | 64 64 68 65 61 64 2e 63 |S/exec/a|ddhead.c|
|00000560| 29 3a 0a 0a 3c 50 3e 0a | 3c 42 52 3e 0a 3c 49 4d |):..<P>.|<BR>.<IM|
|00000570| 47 0a 20 20 53 54 59 4c | 45 3d 22 68 65 69 67 68 |G.  STYL|E="heigh|
|00000580| 74 3a 20 32 2e 33 38 65 | 78 3b 20 76 65 72 74 69 |t: 2.38e|x; verti|
|00000590| 63 61 6c 2d 61 6c 69 67 | 6e 3a 20 31 37 36 2e 31 |cal-alig|n: 176.1|
|000005a0| 39 65 78 3b 20 22 20 53 | 52 43 3d 22 69 6d 67 33 |9ex; " S|RC="img3|
|000005b0| 2e 70 6e 67 22 0a 20 41 | 4c 54 3d 22 5c 62 65 67 |.png". A|LT="\beg|
|000005c0| 69 6e 7b 65 78 61 6d 70 | 6c 65 7d 0a 2f 2a 2a 2a |in{examp|le}./***|
|000005d0| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|000005e0| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|000005f0| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000600| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2e 2e 2e 0a |********|****....|
|00000610| 2e 2e 2e 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |...*****|********|
|00000620| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000630| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000640| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000650| 2a 2a 2f 0a 7b 0a 5c 65 | 6e 64 7b 65 78 61 6d 70 |**/.{.\e|nd{examp|
|00000660| 6c 65 7d 22 3e 0a 3c 42 | 52 3e 0a 0a 3c 50 3e 0a |le}">.<B|R>..<P>.|
|00000670| 41 73 20 79 6f 75 20 63 | 61 6e 20 73 65 65 2c 20 |As you c|an see, |
|00000680| 63 6f 6d 6d 65 6e 74 73 | 20 61 72 65 20 75 73 65 |comments| are use|
|00000690| 64 20 74 6f 20 6d 65 72 | 67 65 20 74 68 65 20 66 |d to mer|ge the f|
|000006a0| 75 6e 63 74 69 6f 6e 20 | 70 72 6f 74 6f 74 79 70 |unction |prototyp|
|000006b0| 65 20 61 6e 64 20 74 68 | 65 0a 68 65 61 64 65 72 |e and th|e.header|
|000006c0| 20 69 6e 74 6f 20 6f 6e | 65 2e 0a 0a 3c 50 3e 0a | into on|e...<P>.|
|000006d0| 3c 44 4c 3e 0a 3c 44 54 | 3e 3c 2f 44 54 3e 0a 3c |<DL>.<DT|></DT>.<|
|000006e0| 44 44 3e 4e 41 4d 45 20 | 54 68 69 73 20 66 69 65 |DD>NAME |This fie|
|000006f0| 6c 64 20 63 6f 6e 74 61 | 69 6e 73 20 61 6c 6c 20 |ld conta|ins all |
|00000700| 6e 65 63 63 65 73 73 61 | 72 79 20 70 72 6f 74 6f |neccessa|ry proto|
|00000710| 74 79 70 65 73 20 74 6f | 20 75 73 65 20 74 68 65 |types to| use the|
|00000720| 20 66 75 6e 63 74 69 6f | 6e 0a 66 72 6f 6d 20 74 | functio|n.from t|
|00000730| 68 65 20 75 73 65 72 20 | 70 6f 69 6e 74 20 6f 66 |he user |point of|
|00000740| 20 76 69 65 77 20 61 6e | 64 20 74 68 65 20 6e 61 | view an|d the na|
|00000750| 6d 65 20 6f 66 20 74 68 | 65 20 66 75 6e 63 74 69 |me of th|e functi|
|00000760| 6f 6e 20 69 6e 20 61 20 | 7c 41 52 4f 53 5f 4c 48 |on in a ||AROS_LH|
|00000770| 2a 28 29 7c 0a 6d 61 63 | 72 6f 20 28 4c 69 62 72 |*()|.mac|ro (Libr|
|00000780| 61 72 79 20 48 65 61 64 | 65 72 29 2e 20 54 68 65 |ary Head|er). The|
|00000790| 73 65 20 6d 61 63 72 6f | 73 20 61 72 65 20 75 73 |se macro|s are us|
|000007a0| 65 64 20 74 6f 20 6d 61 | 6b 65 20 74 68 65 20 73 |ed to ma|ke the s|
|000007b0| 61 6d 65 20 63 6f 64 65 | 20 77 6f 72 6b 20 6f 6e |ame code| work on|
|000007c0| 0a 64 69 66 66 65 72 65 | 6e 74 20 6b 69 6e 64 20 |.differe|nt kind |
|000007d0| 6f 66 20 68 61 72 64 77 | 61 72 65 73 2e 20 54 68 |of hardw|ares. Th|
|000007e0| 65 20 6e 61 6d 65 20 6f | 66 20 74 68 65 20 6d 61 |e name o|f the ma|
|000007f0| 63 72 6f 20 64 65 70 65 | 6e 64 73 20 6f 6e 20 74 |cro depe|nds on t|
|00000800| 68 65 20 61 6d 6f 75 6e | 74 20 6f 66 0a 70 61 72 |he amoun|t of.par|
|00000810| 61 6d 65 74 65 72 73 20 | 61 6e 64 20 77 68 65 74 |ameters |and whet|
|00000820| 68 65 72 20 74 68 65 20 | 66 75 6e 63 74 69 6f 6e |her the |function|
|00000830| 20 6e 65 65 64 73 20 74 | 68 65 20 6c 69 62 72 61 | needs t|he libra|
|00000840| 72 79 20 62 61 73 65 2e | 20 7c 41 64 64 48 65 61 |ry base.| |AddHea|
|00000850| 64 28 29 7c 0a 64 6f 65 | 73 20 6e 6f 74 20 61 6e |d()|.doe|s not an|
|00000860| 64 20 74 68 65 72 65 66 | 6f 72 65 20 61 6e 20 22 |d theref|ore an "|
|00000870| 49 22 20 69 73 20 61 70 | 70 65 6e 64 65 64 20 74 |I" is ap|pended t|
|00000880| 6f 20 74 68 65 20 6d 61 | 63 72 6f 73 20 6e 61 6d |o the ma|cros nam|
|00000890| 65 2e 20 49 66 20 69 74 | 20 6e 65 65 64 0a 74 68 |e. If it| need.th|
|000008a0| 65 20 6c 69 62 72 61 72 | 79 20 62 61 73 65 20 28 |e librar|y base (|
|000008b0| 6c 69 6b 65 20 7c 41 64 | 64 54 61 73 6b 28 29 7c |like |Ad|dTask()||
|000008c0| 29 2c 20 74 68 65 6e 20 | 74 68 65 20 22 49 22 20 |), then |the "I" |
|000008d0| 69 73 20 6f 6d 69 74 74 | 65 64 2e 0a 0a 3c 50 3e |is omitt|ed...<P>|
|000008e0| 0a 49 66 20 74 68 65 20 | 66 75 6e 63 74 69 6f 6e |.If the |function|
|000008f0| 20 69 73 20 6e 6f 74 20 | 70 61 72 74 20 6f 66 20 | is not |part of |
|00000900| 61 20 73 68 61 72 65 64 | 20 6c 69 62 72 61 72 79 |a shared| library|
|00000910| 20 61 6e 64 20 69 74 27 | 73 20 61 72 67 75 6d 65 | and it'|s argume|
|00000920| 6e 74 73 20 6d 75 73 74 | 20 62 65 0a 70 61 73 73 |nts must| be.pass|
|00000930| 65 64 20 69 6e 20 63 65 | 72 74 61 69 6e 20 72 65 |ed in ce|rtain re|
|00000940| 67 69 73 74 65 72 73 20 | 28 65 67 2e 20 63 61 6c |gisters |(eg. cal|
|00000950| 6c 62 61 63 6b 20 68 6f | 6f 6b 73 29 2c 20 79 6f |lback ho|oks), yo|
|00000960| 75 20 6d 75 73 74 20 75 | 73 65 0a 7c 41 52 4f 53 |u must u|se.|AROS|
|00000970| 5f 55 46 48 2a 28 29 7c | 20 6d 61 63 72 6f 73 20 |_UFH*()|| macros |
|00000980| 28 55 73 65 72 20 46 75 | 6e 63 74 69 6f 6e 20 48 |(User Fu|nction H|
|00000990| 65 61 64 65 72 29 20 69 | 6e 73 74 65 61 64 20 6f |eader) i|nstead o|
|000009a0| 66 20 7c 41 52 4f 53 5f | 4c 48 2a 28 29 7c 2e 20 |f |AROS_|LH*()|. |
|000009b0| 41 70 70 65 6e 64 0a 74 | 68 65 20 6e 75 6d 62 65 |Append.t|he numbe|
|000009c0| 72 20 6f 66 20 61 72 67 | 75 6d 65 6e 74 73 20 74 |r of arg|uments t|
|000009d0| 6f 20 74 68 69 73 20 6d | 61 63 72 6f 2e 20 53 69 |o this m|acro. Si|
|000009e0| 6e 63 65 20 69 74 20 68 | 61 73 20 6e 65 76 65 72 |nce it h|as never|
|000009f0| 20 61 20 62 61 73 65 2c | 20 74 68 65 20 66 69 65 | a base,| the fie|
|00000a00| 6c 64 0a 4c 4f 43 41 54 | 49 4f 4e 20 6d 75 73 74 |ld.LOCAT|ION must|
|00000a10| 20 62 65 20 6f 6d 69 74 | 74 65 64 20 61 6e 64 20 | be omit|ted and |
|00000a20| 69 74 27 73 20 6e 6f 74 | 20 6e 65 63 63 65 73 73 |it's not| neccess|
|00000a30| 61 72 79 20 74 6f 20 61 | 70 70 65 6e 64 20 74 68 |ary to a|ppend th|
|00000a40| 65 20 22 49 22 20 74 6f | 20 74 68 65 0a 6d 61 63 |e "I" to| the.mac|
|00000a50| 72 6f 73 20 6e 61 6d 65 | 2e 20 41 6e 20 65 78 61 |ros name|. An exa|
|00000a60| 6d 70 6c 65 20 66 6f 72 | 20 61 20 63 61 6c 6c 62 |mple for| a callb|
|00000a70| 61 63 6b 20 68 6f 6f 6b | 20 7c 66 6f 6f 28 29 7c |ack hook| |foo()||
|00000a80| 20 77 6f 75 6c 64 20 62 | 65 3a 0a 0a 3c 50 3e 0a | would b|e:..<P>.|
|00000a90| 3c 42 52 3e 0a 3c 49 4d | 47 0a 20 20 53 54 59 4c |<BR>.<IM|G.  STYL|
|00000aa0| 45 3d 22 68 65 69 67 68 | 74 3a 20 32 2e 33 38 65 |E="heigh|t: 2.38e|
|00000ab0| 78 3b 20 76 65 72 74 69 | 63 61 6c 2d 61 6c 69 67 |x; verti|cal-alig|
|00000ac0| 6e 3a 20 31 37 36 2e 32 | 37 65 78 3b 20 22 20 53 |n: 176.2|7ex; " S|
|00000ad0| 52 43 3d 22 69 6d 67 34 | 2e 70 6e 67 22 0a 20 41 |RC="img4|.png". A|
|00000ae0| 4c 54 3d 22 5c 62 65 67 | 69 6e 7b 65 78 61 6d 70 |LT="\beg|in{examp|
|00000af0| 6c 65 7d 0a 41 52 4f 53 | 5f 55 46 48 33 28 55 4c |le}.AROS|_UFH3(UL|
|00000b00| 4f 4e 47 2c 20 66 6f 6f | 2c 0a 41 52 4f 53 5f 55 |ONG, foo|,.AROS_U|
|00000b10| 46 48 41 28 73 74 72 75 | 63 74 20 48 6f 6f 6b 2c |FHA(stru|ct Hook,|
|00000b20| 20 68 6f 6f 6b 2c 20 41 | 30 29 2c 0a 41 52 4f 53 | hook, A|0),.AROS|
|00000b30| 5f 55 46 48 41 28 41 50 | 54 52 2c 20 6f 62 6a 2c |_UFHA(AP|TR, obj,|
|00000b40| 20 41 32 29 2c 0a 41 52 | 4f 53 5f 55 46 48 41 28 | A2),.AR|OS_UFHA(|
|00000b50| 41 50 54 52 2c 20 70 61 | 72 61 6d 2c 20 41 31 29 |APTR, pa|ram, A1)|
|00000b60| 0a 29 0a 5c 65 6e 64 7b | 65 78 61 6d 70 6c 65 7d |.).\end{|example}|
|00000b70| 22 3e 0a 3c 42 52 3e 0a | 0a 3c 50 3e 0a 28 6e 6f |">.<BR>.|.<P>.(no|
|00000b80| 74 65 20 74 68 61 74 20 | 74 68 65 20 72 65 67 69 |te that |the regi|
|00000b90| 73 74 65 72 73 20 6e 65 | 65 64 20 6e 6f 74 20 68 |sters ne|ed not h|
|00000ba0| 61 76 65 20 61 20 70 61 | 72 74 69 63 75 6c 61 72 |ave a pa|rticular|
|00000bb0| 20 6f 72 64 65 72 29 2e | 0a 0a 3c 50 3e 0a 49 66 | order).|..<P>.If|
|00000bc0| 20 74 68 65 20 66 75 6e | 63 74 69 6f 6e 20 69 73 | the fun|ction is|
|00000bd0| 20 6e 6f 74 20 70 61 72 | 74 20 6f 66 20 61 20 73 | not par|t of a s|
|00000be0| 68 61 72 65 64 20 6c 69 | 62 72 61 72 79 20 61 6e |hared li|brary an|
|00000bf0| 64 20 69 74 27 73 20 61 | 72 67 75 6d 65 6e 74 73 |d it's a|rguments|
|00000c00| 20 6e 65 65 64 20 6e 6f | 74 0a 62 65 20 69 6e 20 | need no|t.be in |
|00000c10| 73 70 65 63 69 66 69 63 | 20 72 65 67 69 73 74 65 |specific| registe|
|00000c20| 72 73 2c 20 79 6f 75 20 | 6e 65 65 64 20 6e 6f 20 |rs, you |need no |
|00000c30| 7c 41 52 4f 53 5f 2a 48 | 2a 28 29 7c 20 6d 61 63 ||AROS_*H|*()| mac|
|00000c40| 72 6f 73 3a 0a 0a 3c 50 | 3e 0a 3c 42 52 3e 0a 3c |ros:..<P|>.<BR>.<|
|00000c50| 49 4d 47 0a 20 20 53 54 | 59 4c 45 3d 22 68 65 69 |IMG.  ST|YLE="hei|
|00000c60| 67 68 74 3a 20 32 2e 33 | 38 65 78 3b 20 76 65 72 |ght: 2.3|8ex; ver|
|00000c70| 74 69 63 61 6c 2d 61 6c | 69 67 6e 3a 20 31 37 36 |tical-al|ign: 176|
|00000c80| 2e 32 37 65 78 3b 20 22 | 20 53 52 43 3d 22 69 6d |.27ex; "| SRC="im|
|00000c90| 67 35 2e 70 6e 67 22 0a | 20 41 4c 54 3d 22 5c 62 |g5.png".| ALT="\b|
|00000ca0| 65 67 69 6e 7b 65 78 61 | 6d 70 6c 65 7d 0a 2f 2a |egin{exa|mple}./*|
|00000cb0| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000cc0| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000cd0| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000ce0| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2e 2e |********|******..|
|00000cf0| 2e 0a 2e 2e 2e 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |.....***|********|
|00000d00| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000d10| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000d20| 2a 2a 2a 2a 2a 2a 2a 2a | 2a 2a 2a 2a 2a 2a 2a 2a |********|********|
|00000d30| 2a 2a 2a 2a 2a 2a 2f 0a | 5c 65 6e 64 7b 65 78 61 |******/.|\end{exa|
|00000d40| 6d 70 6c 65 7d 22 3e 0a | 3c 42 52 3e 0a 0a 3c 50 |mple}">.|<BR>..<P|
|00000d50| 3e 0a 3c 2f 44 44 3e 0a | 3c 44 54 3e 3c 2f 44 54 |>.</DD>.|<DT></DT|
|00000d60| 3e 0a 3c 44 44 3e 53 59 | 4e 4f 50 53 49 53 20 54 |>.<DD>SY|NOPSIS T|
|00000d70| 68 69 73 20 66 69 65 6c | 64 20 63 6f 6e 74 61 69 |his fiel|d contai|
|00000d80| 6e 73 20 61 6c 6c 20 61 | 72 67 75 6d 65 6e 74 73 |ns all a|rguments|
|00000d90| 20 6f 66 20 74 68 65 20 | 66 75 6e 63 74 69 6f 6e | of the |function|
|00000da0| 20 6f 6e 65 20 62 79 0a | 6f 6e 65 20 69 6e 20 7c | one by.|one in ||
|00000db0| 41 52 4f 53 5f 4c 48 41 | 28 29 7c 20 6d 61 63 72 |AROS_LHA|()| macr|
|00000dc0| 6f 73 20 28 4c 69 62 72 | 61 72 79 20 48 65 61 64 |os (Libr|ary Head|
|00000dd0| 65 72 20 41 72 67 75 6d | 65 6e 74 29 2e 20 54 68 |er Argum|ent). Th|
|00000de0| 69 73 20 6d 61 63 72 6f | 20 6d 61 6b 65 73 20 73 |is macro| makes s|
|00000df0| 75 72 65 0a 74 68 65 20 | 72 65 73 70 65 63 74 69 |ure.the |respecti|
|00000e00| 76 65 20 61 72 67 75 6d | 65 6e 74 20 69 73 20 70 |ve argum|ent is p|
|00000e10| 75 74 20 69 6e 20 74 68 | 65 20 72 69 67 68 74 20 |ut in th|e right |
|00000e20| 43 50 55 20 72 65 67 69 | 73 74 65 72 20 77 68 65 |CPU regi|ster whe|
|00000e30| 6e 20 74 68 65 20 66 75 | 6e 63 74 69 6f 6e 0a 69 |n the fu|nction.i|
|00000e40| 73 20 63 61 6c 6c 65 64 | 20 28 69 66 20 70 6f 73 |s called| (if pos|
|00000e50| 73 69 62 6c 65 20 61 6e | 64 20 6e 65 63 63 65 73 |sible an|d necces|
|00000e60| 73 61 72 79 29 2e 20 54 | 68 65 20 66 69 72 73 74 |sary). T|he first|
|00000e70| 20 61 72 67 75 6d 65 6e | 74 20 66 6f 72 20 74 68 | argumen|t for th|
|00000e80| 65 20 6d 61 63 72 6f 20 | 69 73 0a 74 68 65 20 74 |e macro |is.the t|
|00000e90| 79 70 65 20 6f 66 20 74 | 68 65 20 70 61 72 61 6d |ype of t|he param|
|00000ea0| 65 74 65 72 20 66 6f 6c | 6c 6f 77 65 64 20 62 79 |eter fol|lowed by|
|00000eb0| 20 74 68 65 20 6e 61 6d | 65 20 6f 66 20 74 68 65 | the nam|e of the|
|00000ec0| 20 70 61 72 61 6d 65 74 | 65 72 20 61 6e 64 20 74 | paramet|er and t|
|00000ed0| 68 65 0a 72 65 67 69 73 | 74 65 72 20 74 68 65 20 |he.regis|ter the |
|00000ee0| 70 61 72 61 6d 65 74 65 | 72 20 69 73 20 65 78 70 |paramete|r is exp|
|00000ef0| 65 63 74 65 64 20 69 6e | 2e 20 56 61 6c 69 64 20 |ected in|. Valid |
|00000f00| 6e 61 6d 65 73 20 66 6f | 72 20 72 65 67 69 73 74 |names fo|r regist|
|00000f10| 65 72 73 20 61 72 65 20 | 44 30 2c 0a 44 31 2c 20 |ers are |D0,.D1, |
|00000f20| 44 32 20 75 70 74 6f 20 | 44 37 20 61 6e 64 20 41 |D2 upto |D7 and A|
|00000f30| 30 20 75 70 74 6f 20 41 | 36 2e 0a 0a 3c 50 3e 0a |0 upto A|6...<P>.|
|00000f40| 49 66 20 74 68 65 20 66 | 75 6e 63 74 69 6f 6e 20 |If the f|unction |
|00000f50| 69 73 20 6e 6f 74 20 70 | 61 72 74 20 6f 66 20 61 |is not p|art of a|
|00000f60| 20 6c 69 62 72 61 72 79 | 20 62 75 74 20 74 68 65 | library| but the|
|00000f70| 20 61 72 67 75 6d 65 6e | 74 73 20 6d 75 73 74 20 | argumen|ts must |
|00000f80| 62 65 20 70 61 73 73 65 | 64 0a 74 6f 20 69 74 20 |be passe|d.to it |
|00000f90| 69 6e 20 72 65 67 69 73 | 74 65 72 73 2c 20 74 68 |in regis|ters, th|
|00000fa0| 65 6e 20 75 73 65 20 7c | 41 52 4f 53 5f 55 46 48 |en use ||AROS_UFH|
|00000fb0| 41 28 29 7c 20 6d 61 63 | 72 6f 73 20 28 55 73 65 |A()| mac|ros (Use|
|00000fc0| 72 20 46 75 6e 63 74 69 | 6f 6e 20 48 65 61 64 65 |r Functi|on Heade|
|00000fd0| 72 0a 41 72 67 75 6d 65 | 6e 74 29 20 77 68 69 63 |r.Argume|nt) whic|
|00000fe0| 68 20 74 61 6b 65 20 74 | 68 65 20 73 61 6d 65 20 |h take t|he same |
|00000ff0| 70 61 72 61 6d 65 74 65 | 72 73 20 61 73 20 74 68 |paramete|rs as th|
|00001000| 65 20 7c 41 52 4f 53 5f | 4c 48 41 28 29 7c 20 6d |e |AROS_|LHA()| m|
|00001010| 61 63 72 6f 73 2e 20 44 | 6f 6e 27 74 0a 66 6f 72 |acros. D|on't.for|
|00001020| 67 65 74 20 74 68 65 20 | 63 6c 6f 73 69 6e 67 20 |get the |closing |
|00001030| 70 61 72 65 6e 74 68 65 | 73 65 20 66 6f 72 20 74 |parenthe|se for t|
|00001040| 68 65 20 41 52 4f 53 5f | 55 46 43 0a 0a 3c 50 3e |he AROS_|UFC..<P>|
|00001050| 0a 49 66 20 74 68 65 20 | 66 75 6e 63 74 69 6f 6e |.If the |function|
|00001060| 20 69 73 20 6e 6f 74 20 | 70 61 72 74 20 6f 66 20 | is not |part of |
|00001070| 61 20 6c 69 62 72 61 72 | 79 20 61 6e 64 20 74 68 |a librar|y and th|
|00001080| 65 20 61 72 67 75 6d 65 | 6e 74 73 20 6e 65 65 64 |e argume|nts need|
|00001090| 20 6e 6f 74 20 62 65 0a | 70 61 73 73 65 64 20 69 | not be.|passed i|
|000010a0| 6e 20 72 65 67 69 73 74 | 65 72 73 2c 20 6e 6f 20 |n regist|ers, no |
|000010b0| 6d 61 63 72 6f 73 20 61 | 72 65 20 6e 65 63 63 65 |macros a|re necce|
|000010c0| 73 73 61 72 79 2e 0a 0a | 3c 50 3e 0a 3c 2f 44 44 |ssary...|<P>.</DD|
|000010d0| 3e 0a 3c 44 54 3e 3c 2f | 44 54 3e 0a 3c 44 44 3e |>.<DT></|DT>.<DD>|
|000010e0| 4c 4f 43 41 54 49 4f 4e | 20 54 68 69 73 20 66 69 |LOCATION| This fi|
|000010f0| 65 6c 64 20 69 73 20 6e | 65 63 63 65 73 73 61 72 |eld is n|eccessar|
|00001100| 79 20 66 6f 72 20 73 68 | 61 72 65 64 20 6c 69 62 |y for sh|ared lib|
|00001110| 72 61 72 69 65 73 20 6f | 6e 6c 79 2e 20 49 74 0a |raries o|nly. It.|
|00001120| 63 6f 6e 74 61 69 6e 73 | 20 74 68 65 20 6c 61 73 |contains| the las|
|00001130| 74 20 66 6f 75 72 20 70 | 61 72 61 6d 65 74 65 72 |t four p|arameter|
|00001140| 73 20 66 6f 72 20 74 68 | 65 20 7c 41 52 4f 53 5f |s for th|e |AROS_|
|00001150| 4c 48 2a 28 29 7c 20 6d | 61 63 72 6f 20 77 68 69 |LH*()| m|acro whi|
|00001160| 63 68 20 61 72 65 20 74 | 68 65 0a 74 79 70 65 20 |ch are t|he.type |
|00001170| 6f 66 20 74 68 65 20 6c | 69 62 72 61 72 79 2c 20 |of the l|ibrary, |
|00001180| 74 68 65 20 6e 61 6d 65 | 20 6f 66 20 74 68 65 20 |the name| of the |
|00001190| 76 61 72 69 61 62 6c 65 | 2c 20 69 6e 20 77 68 69 |variable|, in whi|
|000011a0| 63 68 20 74 68 65 20 66 | 75 6e 63 74 69 6f 6e 0a |ch the f|unction.|
|000011b0| 65 78 70 65 63 74 73 20 | 74 68 65 20 6c 69 62 72 |expects |the libr|
|000011c0| 61 72 79 20 62 61 73 65 | 2c 20 74 68 65 20 6f 66 |ary base|, the of|
|000011d0| 66 73 65 74 20 6f 66 20 | 74 68 65 20 66 75 6e 63 |fset of |the func|
|000011e0| 74 69 6f 6e 20 69 6e 20 | 74 68 65 20 6a 75 6d 70 |tion in |the jump|
|000011f0| 74 61 62 6c 65 20 28 74 | 68 65 0a 66 69 72 73 74 |table (t|he.first|
|00001200| 20 76 65 63 74 6f 72 20 | 68 61 73 20 31 20 61 6e | vector |has 1 an|
|00001210| 64 20 74 68 65 20 66 69 | 72 73 74 20 76 65 63 74 |d the fi|rst vect|
|00001220| 6f 72 20 77 68 69 63 68 | 20 6d 61 79 20 62 65 20 |or which| may be |
|00001230| 75 73 65 64 20 62 79 20 | 61 20 66 75 6e 63 74 69 |used by |a functi|
|00001240| 6f 6e 20 69 73 0a 35 29 | 20 61 6e 64 20 74 68 65 |on is.5)| and the|
|00001250| 20 6e 61 6d 65 20 6f 66 | 20 74 68 65 20 6c 69 62 | name of| the lib|
|00001260| 72 61 72 79 2e 0a 0a 3c | 50 3e 0a 3c 2f 44 44 3e |rary...<|P>.</DD>|
|00001270| 0a 3c 44 54 3e 3c 2f 44 | 54 3e 0a 3c 44 44 3e 46 |.<DT></D|T>.<DD>F|
|00001280| 55 4e 43 54 49 4f 4e 20 | 54 68 69 73 20 66 69 65 |UNCTION |This fie|
|00001290| 6c 64 20 63 6f 6e 74 61 | 69 6e 73 20 61 20 64 65 |ld conta|ins a de|
|000012a0| 73 63 72 69 70 74 69 6f | 6e 20 6f 66 20 74 68 65 |scriptio|n of the|
|000012b0| 20 66 75 6e 63 74 69 6f | 6e 2e 0a 0a 3c 50 3e 0a | functio|n...<P>.|
|000012c0| 3c 2f 44 44 3e 0a 3c 44 | 54 3e 3c 2f 44 54 3e 0a |</DD>.<D|T></DT>.|
|000012d0| 3c 44 44 3e 49 4e 50 55 | 54 53 20 54 68 69 73 20 |<DD>INPU|TS This |
|000012e0| 66 69 65 6c 64 20 63 6f | 6e 74 61 69 6e 73 20 61 |field co|ntains a|
|000012f0| 20 6c 69 73 74 20 6f 66 | 20 61 6c 6c 20 70 61 72 | list of| all par|
|00001300| 61 6d 65 74 65 72 73 20 | 6f 66 20 74 68 65 20 66 |ameters |of the f|
|00001310| 6f 72 6d 0a 22 6e 61 6d | 65 20 2d 20 64 65 73 63 |orm."nam|e - desc|
|00001320| 72 69 70 74 69 6f 6e 22 | 20 6f 72 20 22 6e 61 6d |ription"| or "nam|
|00001330| 65 2c 20 6e 61 6d 65 2c | 20 6e 61 6d 65 20 2d 20 |e, name,| name - |
|00001340| 64 65 73 63 72 69 70 74 | 69 6f 6e 22 2e 20 54 68 |descript|ion". Th|
|00001350| 65 20 64 65 73 63 72 69 | 70 74 69 6f 6e 0a 73 68 |e descri|ption.sh|
|00001360| 6f 75 6c 64 20 74 65 6c | 6c 20 77 68 61 74 20 74 |ould tel|l what t|
|00001370| 68 65 20 70 61 72 61 6d | 65 74 65 72 20 69 73 20 |he param|eter is |
|00001380| 61 6e 64 20 77 68 61 74 | 20 76 61 6c 75 65 73 20 |and what| values |
|00001390| 63 61 6e 20 62 65 20 70 | 61 73 73 65 64 20 74 6f |can be p|assed to|
|000013a0| 20 69 74 2e 0a 54 68 65 | 72 65 20 69 73 20 6e 6f | it..The|re is no|
|000013b0| 20 70 6f 69 6e 74 20 69 | 6e 20 65 78 70 6c 61 69 | point i|n explai|
|000013c0| 6e 69 6e 67 20 74 68 65 | 20 70 61 72 61 6d 65 74 |ning the| paramet|
|000013d0| 65 72 20 74 77 69 63 65 | 20 69 6e 20 46 55 4e 43 |er twice| in FUNC|
|000013e0| 54 49 4f 4e 20 61 6e 64 | 20 68 65 72 65 2e 0a 49 |TION and| here..I|
|000013f0| 66 20 74 68 65 20 66 75 | 6e 63 74 69 6f 6e 20 68 |f the fu|nction h|
|00001400| 61 73 20 6e 6f 20 70 61 | 72 61 6d 65 74 65 72 73 |as no pa|rameters|
|00001410| 2c 20 73 61 79 20 22 4e | 6f 6e 65 2e 22 20 68 65 |, say "N|one." he|
|00001420| 72 65 2e 0a 0a 3c 50 3e | 0a 3c 2f 44 44 3e 0a 3c |re...<P>|.</DD>.<|
|00001430| 44 54 3e 3c 2f 44 54 3e | 0a 3c 44 44 3e 52 45 53 |DT></DT>|.<DD>RES|
|00001440| 55 4c 54 20 57 68 61 74 | 20 74 68 65 20 66 75 6e |ULT What| the fun|
|00001450| 63 74 69 6f 6e 20 70 61 | 73 73 65 73 20 62 61 63 |ction pa|sses bac|
|00001460| 6b 2e 20 54 68 69 73 20 | 69 6e 63 6c 75 64 65 73 |k. This |includes|
|00001470| 20 72 65 74 75 72 6e 20 | 76 61 6c 75 65 73 0a 61 | return |values.a|
|00001480| 6e 64 20 76 61 6c 75 65 | 73 20 70 61 73 73 65 64 |nd value|s passed|
|00001490| 20 69 6e 20 61 72 67 75 | 6d 65 6e 74 73 20 6f 66 | in argu|ments of|
|000014a0| 20 74 68 65 20 66 75 6e | 63 74 69 6f 6e 2e 20 49 | the fun|ction. I|
|000014b0| 66 20 74 68 65 20 66 75 | 6e 63 74 69 6f 6e 20 6d |f the fu|nction m|
|000014c0| 61 79 20 66 61 69 6c 2c | 0a 79 6f 75 20 73 68 6f |ay fail,|.you sho|
|000014d0| 75 6c 64 20 65 78 70 6c | 61 69 6e 20 77 68 61 74 |uld expl|ain what|
|000014e0| 20 69 74 20 72 65 74 75 | 72 6e 73 20 6f 6e 20 66 | it retu|rns on f|
|000014f0| 61 69 6c 75 72 65 20 61 | 6e 64 20 77 68 79 20 69 |ailure a|nd why i|
|00001500| 74 20 6d 69 67 68 74 20 | 66 61 69 6c 2e 0a 0a 3c |t might |fail...<|
|00001510| 50 3e 0a 3c 2f 44 44 3e | 0a 3c 44 54 3e 3c 2f 44 |P>.</DD>|.<DT></D|
|00001520| 54 3e 0a 3c 44 44 3e 4e | 4f 54 45 53 20 49 6d 70 |T>.<DD>N|OTES Imp|
|00001530| 6f 72 74 61 6e 74 20 74 | 68 69 6e 67 73 20 74 68 |ortant t|hings th|
|00001540| 65 20 75 73 65 72 20 6d | 75 73 74 20 6b 6e 6f 77 |e user m|ust know|
|00001550| 20 6f 72 20 74 61 6b 65 | 20 69 6e 74 6f 20 61 63 | or take| into ac|
|00001560| 63 6f 75 6e 74 2e 0a 0a | 3c 50 3e 0a 3c 2f 44 44 |count...|<P>.</DD|
|00001570| 3e 0a 3c 44 54 3e 3c 2f | 44 54 3e 0a 3c 44 44 3e |>.<DT></|DT>.<DD>|
|00001580| 45 58 41 4d 50 4c 45 20 | 54 68 69 73 20 66 69 65 |EXAMPLE |This fie|
|00001590| 6c 64 20 73 68 6f 75 6c | 64 20 63 6f 6e 74 61 69 |ld shoul|d contai|
|000015a0| 6e 20 61 20 73 6d 61 6c | 6c 20 6f 72 20 66 75 6c |n a smal|l or ful|
|000015b0| 6c 79 20 66 65 61 74 75 | 72 65 64 20 65 78 61 6d |ly featu|red exam|
|000015c0| 70 6c 65 2e 0a 41 20 67 | 6f 6f 64 20 77 61 79 20 |ple..A g|ood way |
|000015d0| 74 6f 20 70 72 65 73 65 | 6e 74 20 61 6e 20 65 78 |to prese|nt an ex|
|000015e0| 61 6d 70 6c 65 20 69 73 | 20 74 6f 20 77 72 69 74 |ample is| to writ|
|000015f0| 65 20 73 6f 6d 65 20 63 | 6f 64 65 20 77 68 69 63 |e some c|ode whic|
|00001600| 68 20 74 65 73 74 73 20 | 74 68 65 0a 66 75 6e 63 |h tests |the.func|
|00001610| 74 69 6f 6e 2c 20 70 75 | 74 20 69 74 20 69 6e 74 |tion, pu|t it int|
|00001620| 6f 20 7c 23 69 66 64 65 | 66 20 54 45 53 54 7c 20 |o |#ifde|f TEST| |
|00001630| 73 6f 6d 65 77 68 65 72 | 65 20 69 6e 20 74 68 65 |somewher|e in the|
|00001640| 20 66 69 6c 65 20 61 6e | 64 20 70 75 74 20 61 0a | file an|d put a.|
|00001650| 22 53 65 65 20 62 65 6c | 6f 77 2e 22 20 68 65 72 |"See bel|ow." her|
|00001660| 65 2e 20 49 66 20 79 6f | 75 20 6e 65 65 64 20 63 |e. If yo|u need c|
|00001670| 6f 6d 6d 65 6e 74 73 20 | 69 6e 20 74 68 65 20 63 |omments |in the c|
|00001680| 6f 64 65 2c 20 79 6f 75 | 20 68 61 76 65 20 74 77 |ode, you| have tw|
|00001690| 6f 20 77 61 79 73 20 66 | 6f 72 0a 74 68 69 73 2e |o ways f|or.this.|
|000016a0| 20 49 66 20 79 6f 75 20 | 6e 65 65 64 20 6f 6e 6c | If you |need onl|
|000016b0| 79 20 73 68 6f 72 74 20 | 6f 6e 65 2d 6c 69 6e 65 |y short |one-line|
|000016c0| 20 63 6f 6d 6d 65 6e 74 | 73 2c 20 75 73 65 20 43 | comment|s, use C|
|000016d0| 2b 2b 20 73 74 79 6c 65 | 20 28 7c 2f 2f 0a 63 6f |++ style| (|//.co|
|000016e0| 6d 6d 65 6e 74 7c 29 2e | 20 45 76 65 72 79 74 68 |mment|).| Everyth|
|000016f0| 69 6e 67 20 66 72 6f 6d | 20 74 68 65 20 7c 2f 2f |ing from| the |//|
|00001700| 7c 20 74 6f 20 74 68 65 | 20 65 6e 64 20 69 66 20 || to the| end if |
|00001710| 74 68 65 20 6c 69 6e 65 | 20 69 73 20 74 68 65 20 |the line| is the |
|00001720| 63 6f 6d 6d 65 6e 74 2e | 0a 49 66 20 79 6f 75 20 |comment.|.If you |
|00001730| 6e 65 65 64 20 6d 6f 72 | 65 20 63 6f 6d 6d 65 6e |need mor|e commen|
|00001740| 74 2c 20 74 68 65 6e 20 | 79 6f 75 20 63 61 6e 20 |t, then |you can |
|00001750| 65 6e 64 20 74 68 65 20 | 63 6f 6d 6d 65 6e 74 20 |end the |comment |
|00001760| 61 66 74 65 72 20 74 68 | 65 20 7c 45 58 41 4d 50 |after th|e |EXAMP|
|00001770| 4c 45 7c 0a 61 6e 64 20 | 75 73 65 20 7c 23 69 66 |LE|.and |use |#if|
|00001780| 64 65 66 20 45 58 41 4d | 50 4c 45 7c 20 74 6f 20 |def EXAM|PLE| to |
|00001790| 6d 61 73 6b 20 74 68 65 | 20 65 78 61 6d 70 6c 65 |mask the| example|
|000017a0| 20 6f 75 74 3a 0a 0a 3c | 50 3e 0a 3c 42 52 3e 0a | out:..<|P>.<BR>.|
|000017b0| 3c 49 4d 47 0a 20 20 53 | 54 59 4c 45 3d 22 68 65 |<IMG.  S|TYLE="he|
|000017c0| 69 67 68 74 3a 20 32 2e | 33 38 65 78 3b 20 76 65 |ight: 2.|38ex; ve|
|000017d0| 72 74 69 63 61 6c 2d 61 | 6c 69 67 6e 3a 20 31 37 |rtical-a|lign: 17|
|000017e0| 36 2e 32 37 65 78 3b 20 | 22 20 53 52 43 3d 22 69 |6.27ex; |" SRC="i|
|000017f0| 6d 67 36 2e 70 6e 67 22 | 0a 20 41 4c 54 3d 22 5c |mg6.png"|. ALT="\|
|00001800| 62 65 67 69 6e 7b 65 78 | 61 6d 70 6c 65 7d 0a 45 |begin{ex|ample}.E|
|00001810| 58 41 4d 50 4c 45 20 2a | 2f 0a 2e 2e 2e 22 3e 0a |XAMPLE *|/....">.|
|00001820| 3c 42 52 3e 0a 0a 3c 50 | 3e 0a 44 6f 6e 27 74 20 |<BR>..<P|>.Don't |
|00001830| 75 73 65 20 7c 23 69 66 | 64 65 66 20 45 58 41 4d |use |#if|def EXAM|
|00001840| 50 4c 45 7c 20 69 66 20 | 79 6f 75 20 68 61 76 65 |PLE| if |you have|
|00001850| 20 61 20 66 75 6c 6c 79 | 20 66 65 61 74 75 72 65 | a fully| feature|
|00001860| 64 20 65 78 61 6d 70 6c | 65 20 28 69 65 2e 20 6f |d exampl|e (ie. o|
|00001870| 6e 65 0a 77 68 69 63 68 | 20 63 61 6e 20 62 65 20 |ne.which| can be |
|00001880| 63 6f 6d 70 69 6c 65 64 | 20 77 69 74 68 6f 75 74 |compiled| without|
|00001890| 20 65 72 72 6f 72 73 29 | 2e 0a 0a 3c 50 3e 0a 3c | errors)|...<P>.<|
|000018a0| 2f 44 44 3e 0a 3c 44 54 | 3e 3c 2f 44 54 3e 0a 3c |/DD>.<DT|></DT>.<|
|000018b0| 44 44 3e 42 55 47 53 20 | 54 68 69 73 20 66 69 65 |DD>BUGS |This fie|
|000018c0| 6c 64 20 63 6f 6e 74 61 | 69 6e 73 20 61 20 6c 69 |ld conta|ins a li|
|000018d0| 73 74 20 6f 66 20 6b 6e | 6f 77 6e 20 62 75 67 73 |st of kn|own bugs|
|000018e0| 2e 0a 0a 3c 50 3e 0a 3c | 2f 44 44 3e 0a 3c 44 54 |...<P>.<|/DD>.<DT|
|000018f0| 3e 3c 2f 44 54 3e 0a 3c | 44 44 3e 53 45 45 20 41 |></DT>.<|DD>SEE A|
|00001900| 4c 53 4f 20 54 68 69 73 | 20 66 69 65 6c 64 20 63 |LSO This| field c|
|00001910| 6f 6e 74 61 69 6e 73 20 | 61 20 6c 69 73 74 20 6f |ontains |a list o|
|00001920| 66 20 6f 74 68 65 72 20 | 66 75 6e 63 74 69 6f 6e |f other |function|
|00001930| 73 20 61 6e 64 20 64 6f | 63 75 6d 65 6e 74 73 0a |s and do|cuments.|
|00001940| 77 68 69 63 68 20 6d 69 | 67 68 74 20 62 65 20 6f |which mi|ght be o|
|00001950| 66 20 69 6e 74 65 72 65 | 73 74 2e 20 54 68 69 73 |f intere|st. This|
|00001960| 20 69 6e 63 6c 75 64 65 | 73 20 66 75 6e 63 74 69 | include|s functi|
|00001970| 6f 6e 20 77 68 69 63 68 | 20 79 6f 75 20 6e 65 65 |on which| you nee|
|00001980| 64 20 74 6f 0a 69 6e 69 | 74 69 61 6c 69 7a 65 2c |d to.ini|tialize,|
|00001990| 20 63 72 65 61 74 65 20 | 6f 72 20 64 65 73 74 72 | create |or destr|
|000019a0| 6f 79 20 61 6e 20 6f 62 | 6a 65 63 74 20 6e 65 63 |oy an ob|ject nec|
|000019b0| 65 73 73 61 72 79 20 66 | 6f 72 20 74 68 69 73 20 |essary f|or this |
|000019c0| 66 75 6e 63 74 69 6f 6e | 2c 0a 66 75 6e 63 74 69 |function|,.functi|
|000019d0| 6f 6e 73 20 77 68 69 63 | 68 20 64 6f 20 73 69 6d |ons whic|h do sim|
|000019e0| 69 6c 61 72 20 61 6e 64 | 20 6f 70 70 6f 73 69 74 |ilar and| opposit|
|000019f0| 65 20 74 68 69 6e 67 73 | 20 6f 6e 20 74 68 65 20 |e things| on the |
|00001a00| 6d 61 69 6e 20 6f 62 6a | 65 63 74 2e 0a 0a 3c 50 |main obj|ect...<P|
|00001a10| 3e 0a 46 6f 72 20 65 78 | 61 6d 70 6c 65 2c 20 7c |>.For ex|ample, ||
|00001a20| 53 65 74 41 74 74 72 73 | 28 29 7c 20 73 68 6f 75 |SetAttrs|()| shou|
|00001a30| 6c 64 20 63 6f 6e 74 61 | 69 6e 20 66 75 6e 63 74 |ld conta|in funct|
|00001a40| 69 6f 6e 73 20 68 65 72 | 65 20 77 68 69 63 68 20 |ions her|e which |
|00001a50| 63 61 6e 20 63 72 65 61 | 74 65 2c 0a 64 65 73 74 |can crea|te,.dest|
|00001a60| 72 6f 79 20 61 6e 64 20 | 6d 61 6e 69 70 75 6c 61 |roy and |manipula|
|00001a70| 74 65 20 42 4f 4f 50 53 | 49 20 6f 62 6a 65 63 74 |te BOOPS|I object|
|00001a80| 73 20 62 75 74 20 6e 6f | 74 20 74 61 67 6c 69 73 |s but no|t taglis|
|00001a90| 74 73 2e 0a 0a 3c 50 3e | 0a 3c 2f 44 44 3e 0a 3c |ts...<P>|.</DD>.<|
|00001aa0| 44 54 3e 3c 2f 44 54 3e | 0a 3c 44 44 3e 49 4e 54 |DT></DT>|.<DD>INT|
|00001ab0| 45 52 4e 41 4c 53 20 54 | 68 69 73 20 66 69 65 6c |ERNALS T|his fiel|
|00001ac0| 64 20 73 68 6f 75 6c 64 | 20 63 6f 6e 74 61 69 6e |d should| contain|
|00001ad0| 20 69 6e 66 6f 72 6d 61 | 74 69 6f 6e 20 66 6f 72 | informa|tion for|
|00001ae0| 20 6f 74 68 65 72 20 64 | 65 76 65 6c 6f 70 65 72 | other d|eveloper|
|00001af0| 73 0a 77 68 69 63 68 20 | 61 72 65 20 69 72 72 65 |s.which |are irre|
|00001b00| 6c 65 76 61 6e 74 20 74 | 6f 20 74 68 65 20 75 73 |levant t|o the us|
|00001b10| 65 72 2c 20 66 6f 72 20 | 65 78 61 6d 70 6c 65 20 |er, for |example |
|00001b20| 61 6e 20 65 78 70 6c 61 | 6e 61 74 69 6f 6e 20 6f |an expla|nation o|
|00001b30| 66 20 74 68 65 0a 61 6c | 67 6f 72 69 74 68 6d 20 |f the.al|gorithm |
|00001b40| 6f 66 20 74 68 65 20 66 | 75 6e 63 74 69 6f 6e 20 |of the f|unction |
|00001b50| 6f 72 20 64 65 70 65 6e | 64 65 6e 63 69 65 73 2e |or depen|dencies.|
|00001b60| 0a 0a 3c 50 3e 0a 3c 2f | 44 44 3e 0a 3c 44 54 3e |..<P>.</|DD>.<DT>|
|00001b70| 3c 2f 44 54 3e 0a 3c 44 | 44 3e 48 49 53 54 4f 52 |</DT>.<D|D>HISTOR|
|00001b80| 59 20 54 68 69 73 20 66 | 69 65 6c 64 20 73 68 6f |Y This f|ield sho|
|00001b90| 75 6c 64 20 63 6f 6e 74 | 61 69 6e 20 61 20 62 72 |uld cont|ain a br|
|00001ba0| 69 65 66 20 68 69 73 74 | 6f 72 79 20 6f 66 20 63 |ief hist|ory of c|
|00001bb0| 68 61 6e 67 65 73 2e 0a | 54 68 65 20 66 6f 72 6d |hanges..|The form|
|00001bc0| 61 74 20 69 73 20 64 61 | 74 65 20 28 44 44 2d 4d |at is da|te (DD-M|
|00001bd0| 4d 2d 59 59 29 2c 20 61 | 63 72 6f 6e 79 6d 20 28 |M-YY), a|cronym (|
|00001be0| 6f 6e 65 20 77 6f 72 64 | 29 20 61 6e 64 20 64 65 |one word|) and de|
|00001bf0| 73 63 72 69 70 74 69 6f | 6e 2e 0a 0a 3c 50 3e 0a |scriptio|n...<P>.|
|00001c00| 3c 2f 44 44 3e 0a 3c 2f | 44 4c 3e 0a 0a 3c 50 3e |</DD>.</|DL>..<P>|
|00001c10| 0a 0a 3c 48 52 3e 0a 0a | 3c 2f 42 4f 44 59 3e 0a |..<HR>..|</BODY>.|
|00001c20| 3c 2f 48 54 4d 4c 3e 0a |                         |</HTML>.|        |
+--------+-------------------------+-------------------------+--------+--------+