From fe4ec14a831b020852aad8f61a63342329656026 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20GIBERT?= Date: Sat, 22 Oct 2016 22:52:00 +0200 Subject: [PATCH] Kernel version 0.8 : Docs... --- _Docs/KERNEL.md | 148 ++++++++++++++++++++++++------------------------ 1 file changed, 73 insertions(+), 75 deletions(-) diff --git a/_Docs/KERNEL.md b/_Docs/KERNEL.md index a551d058..9cf668df 100644 --- a/_Docs/KERNEL.md +++ b/_Docs/KERNEL.md @@ -1,4 +1,4 @@ -*** Auto generated by docgen.cmd *** +*** Auto generated by docgen.cmd *** #FOpen Open a file ##In : @@ -11,84 +11,82 @@ Open a file + SYS.FOPEN.T : Open/Append in Text mode + SYS.FOPEN.X : Create if not exists + PUSHW = PATH (PSTR) - -##Out : +##Out : + CC : A = hFILE + CS : A = EC - #FCloseA Close a file ##In : + A = hFILE ##Out : -#FRead -Read bytes from file -##In : -+ PULLB = hFILE -+ PULLW = Bytes To Read -+ PULLW = Dest Ptr -##Out : -+ Y,A = Bytes Read -#FWrite -##In : -+ PULLB = hFILE -+ PULLW = Bytes To Write -+ PULLW = Src Ptr -#Out : -+ Y,A = Bytes Written -#NewPStrYA -Create a new copy of PSTR -##In: -+ Y,A = PTR to buffer -##Out: -+ CC : success - + Y,A = PTR to String - + X = hMem (PSTRING) -+ CS : error - + A = SYS error code -#PStrMatch -Compare a String against pattern -##In: - + PUSHW = PTR to Pattern (e.g. '*test?.txt') - + PUSHW = PTR to Src String -##Out: - + CC : match - + CS : no match -#PStrUprYA/PStrLwrYA -Convert string to UPPERCASE/lowercase -##In: - + Y,A = PTR to String (PSTRING) -##Out: - + Uppercased/lowercased String in Buffer -#PStrFTime -Convert S.TIME struct to PSTR -##In : -+ PUSHW = Dst PTR To PSTR Buf -+ PUSHW = Src PTR To Format String - + %a : Abbreviated weekday name : Thu - + %A : Full weekday name : Thursday - + %b : Abbreviated month name : Aug - + %B : Full month name : August - + %d : Day of the month, zero-padded (01-31) - + %H : Hour in 24h format (00-23) 14 - + %I : Hour in 12h format (01-12) 02 - + %m : Month as a decimal number (01-12) 08 - + %M : Minute (00-59) 55 - + %p : AM or PM designation PM - + %S : Second (00-61) 02 - + %w : Weekday as a decimal number with Sunday as 0 (0-6) - + %y : Year, last two digits (00-99) - + %Y : Year four digits 2001 -+ PUSHW = Src PTR To S.Time -##Out : - + none. always succeed. -#K.PStr2StrArrayYA -Convert a PSTR (e.g. : command Line) to a Array of PSTRs (Args[]) -##In : -+ Y,A = PTR to String -##Out : -+ CC : success - + Y,A = PTR to StrArray - + X = hMem -+ CS : error - + A = SYS error code +#FRead +Read bytes from file +##In : ++ PULLB = hFILE ++ PULLW = Bytes To Read ++ PULLW = Dest Ptr +##Out : ++ Y,A = Bytes Read +#FWrite +##In : ++ PULLB = hFILE ++ PULLW = Bytes To Write ++ PULLW = Src Ptr +#Out : ++ Y,A = Bytes Written +#NewPStrYA +Create a new copy of PSTR +##In: ++ Y,A = PTR to buffer +##Out: ++ CC : success + + Y,A = PTR to String + + X = hMem (PSTRING) ++ CS : error + + A = SYS error code +#PStrMatch +Compare a String against pattern +##In: + + PUSHW = PTR to Pattern (e.g. '*test?.txt') + + PUSHW = PTR to Src String +##Out: + + CC : match + + CS : no match +#PStrUprYA/PStrLwrYA +Convert string to UPPERCASE/lowercase +##In: + + Y,A = PTR to String (PSTRING) +##Out: + + Uppercased/lowercased String in Buffer +#PStrFTime +Convert S.TIME struct to PSTR +##In : ++ PUSHW = Dst PTR To PSTR Buf ++ PUSHW = Src PTR To Format String + + %a : Abbreviated weekday name : Thu + + %A : Full weekday name : Thursday + + %b : Abbreviated month name : Aug + + %B : Full month name : August + + %d : Day of the month, zero-padded (01-31) + + %H : Hour in 24h format (00-23) 14 + + %I : Hour in 12h format (01-12) 02 + + %m : Month as a decimal number (01-12) 08 + + %M : Minute (00-59) 55 + + %p : AM or PM designation PM + + %S : Second (00-61) 02 + + %w : Weekday as a decimal number with Sunday as 0 (0-6) + + %y : Year, last two digits (00-99) + + %Y : Year four digits 2001 ++ PUSHW = Src PTR To S.Time +##Out : + + none. always succeed. +#K.PStr2StrArrayYA +Convert a PSTR (e.g. : command Line) to a Array of PSTRs (Args[]) +##In : ++ Y,A = PTR to String +##Out : ++ CC : success + + Y,A = PTR to StrArray + + X = hMem ++ CS : error + + A = SYS error code