Apple-2-SW/A2osX
1
0
Fork 0
mirror of https://github.com/A2osX/A2osX.git synced 2024-10-12 10:23:48 +00:00
Code Issues Projects Releases Wiki Activity

Kernel version 0.8 : Docs...

Browse Source
This commit is contained in:
Rémy GIBERT 2016-10-22 22:58:29 +02:00
parent 25d3ed6ba7
commit c786dd2a9c
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
_Docs/KERNEL.md
View File

@ -1,6 +1,7 @@
*** Auto generated by docgen.cmd *** *** Auto generated by docgen.cmd ***
#FOpen #FOpen
Open a file Open a file
##In : ##In :
+ PUSHW = AUXTYPE + PUSHW = AUXTYPE
+ PUSHB = TYPE + PUSHB = TYPE
@ -17,18 +18,23 @@ Open a file
+ 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
@ -37,8 +43,10 @@ Read bytes from file
+ 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
@ -47,20 +55,25 @@ Create a new copy of PSTR
+ 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
@ -79,12 +92,15 @@ Convert S.TIME struct to PSTR
+ %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