]> gitweb.factorcode.org Git - factor.git/blob - basis/io/files/windows/windows-docs.factor
d9b3e16a8ba720864ce5404265ead7a8c81fd05e
[factor.git] / basis / io / files / windows / windows-docs.factor
1 USING: help.markup help.syntax ;
2 IN: io.files.windows
3
4 HELP: open-read
5 { $values { "path" "a filesystem path" } { "win32-file" "a win32 file-handle" } }
6 { $description "Opens a file for reading and returns a filehandle to it." }
7 { $examples
8   { $example
9     "USING: io.files.windows ;"
10     "\"resource:core/kernel/kernel.factor\" absolute-path open-read ."
11     "T{ win32-file { handle ALIEN: 234 } { ptr 0 } }"
12   }
13 } ;