Kernel version 0.8 : Docs...

This commit is contained in:
Rémy GIBERT 2016-10-22 22:52:00 +02:00
parent 3096ad9f07
commit fe4ec14a83

View File

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