A2osX/_Docs/KERNEL.md
2016-10-23 18:27:20 +02:00

190 lines
2.8 KiB
Markdown

*** Auto generated by docgen.cmd ***
#GetArgC
##In:
+ none.
##Out:
+ A = Command line Arg Count (Including /path/cmd)
#GetArgA
##In:
+ none.
##Out:
+ CC : success
+ Y,A = PStr To Arg[A]
+ CS : Out Of Bound
#FOpen
Open a file
##In :
+ PUSHW = AUXTYPE
+ PUSHB = TYPE
+ PUSHB = MODE
+ SYS.FOPEN.R : if R and exists -> ERROR
+ SYS.FOPEN.W : if W and exists -> CREATE
+ SYS.FOPEN.A : Append
+ SYS.FOPEN.T : Open/Append in Text mode
+ SYS.FOPEN.X : Create if not exists
+ PUSHW = PATH (PSTR)
##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
#FFLUSHA
##In:
+ A = hFILE
#FSEEK
##In:
+ PUSHW = OffsetHi
+ PUSHW = OffsetLo
+ PUSHB = From
+ PUSHB = hFILE
#FTELLA
##In:
+ A = hFILE
##Out:
+ Y,A,X = Offset
#FEOFA
##In:
+ A = hFILE
##Out:
+ CC :
+ A=0 EOF
+ A =0 NOT EOF
+ CS :
#REMOVEYA
#RENAME
Rename a file
##In :
+ PUSHW = New Name
+ PUSHW = Old Name
##Out :
#STAT
Return information about a file
##In :
+ PUSHW = PTR to S.STAT buffer
+ PUSHW = PTR to Filename (PSTR)
##Out :
#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.
#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