dragonleo/NSIS
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Features list updated, some links added and command parameters are now shown alone with a light background behind them.

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1476 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik 2002-10-26 19:23:10 +00:00
parent 2bb6c55b0f
commit 41a03f754c
24 changed files with 497 additions and 464 deletions
Download patch file Download diff file Expand all files Collapse all files

40
Docs/src/file.but
View file

@ -2,60 +2,60 @@
\H{FileClose} FileClose
FileClose \e{handle}
\c handle
Closes a file handle opened with FileOpen.
Closes a file handle opened with FileOpen.
\H{FileOpen} FileOpen
FileOpen \e{user_var(handle output) filename openmode}
\c user_var(handle output) filename openmode
Opens a file named "filename", and sets the handle output variable with the handle. The openmode should be one of "r" (read) "w" (write, all contents of file are destroyed) or "a" (append, meaning opened for both read and write, contents preserved). In all open modes, the file pointer is placed at the beginning of the file. If the file cannot be opened, the handle output is set to empty, and the error flag is set.
Opens a file named "filename", and sets the handle output variable with the handle. The openmode should be one of "r" (read) "w" (write, all contents of file are destroyed) or "a" (append, meaning opened for both read and write, contents preserved). In all open modes, the file pointer is placed at the beginning of the file. If the file cannot be opened, the handle output is set to empty, and the error flag is set.
\H{FileRead} FileRead
FileRead \e{handle user_var(output) [maxlen]}
\c handle user_var(output) [maxlen]
Reads a string from a file opened with FileOpen. The string is read until either a newline (or carriage return newline pair) occurs, or until a null byte is read, or until maxlen is met (if specified). Strings are limited to 1024 characters. If the end of file is read and no more data is available, the output string will be empty, and the error flag will be set.
Reads a string from a file opened with FileOpen. The string is read until either a newline (or carriage return newline pair) occurs, or until a null byte is read, or until maxlen is met (if specified). Strings are limited to 1024 characters. If the end of file is read and no more data is available, the output string will be empty, and the error flag will be set.
\H{FileReadByte} FileReadByte
FileReadByte \e{handle user_var(output)}
\c handle user_var(output)
Reads a byte from a file opened with FileOpen. The byte is stored in the output as an integer (0-255). If the end of file is read and no more data is available, the output will be empty, and the error flag will be set.
Reads a byte from a file opened with FileOpen. The byte is stored in the output as an integer (0-255). If the end of file is read and no more data is available, the output will be empty, and the error flag will be set.
\H{FileSeek} FileSeek
FileSeek \e{handle offset [mode] [user_var(new position)]}
\c handle offset [mode] [user_var(new position)]
Seeks a file opened with FileOpen. If mode is omitted or specified as SET, the file is positioned to "offset". If mode is specified as CUR, then the file pointer is moved by offset. If mode is specified as END, the file pointer is set to a position relative to EOF. If the final parameter "new position" is specified, the new file position will be stored to that variable.
Seeks a file opened with FileOpen. If mode is omitted or specified as SET, the file is positioned to "offset". If mode is specified as CUR, then the file pointer is moved by offset. If mode is specified as END, the file pointer is set to a position relative to EOF. If the final parameter "new position" is specified, the new file position will be stored to that variable.
\H{FileWrite} FileWrite
FileWrite \e{handle string}
\c handle string
Writes a string to a file opened with FileOpen. If an error occurs writing, the error flag will be set.
Writes a string to a file opened with FileOpen. If an error occurs writing, the error flag will be set.
\H{FileWriteByte} FileWriteByte
FileWriteByte \e{handle string}
\c handle string
Writes the integer interpretation of 'string' to a file opened with FileOpen. If an error occurs writing, the error flag will be set. Note that the low byte of the integer is used, i.e. writing 256 is the same as writing 0, etc.
Writes the integer interpretation of 'string' to a file opened with FileOpen. If an error occurs writing, the error flag will be set. Note that the low byte of the integer is used, i.e. writing 256 is the same as writing 0, etc.
\H{FindClose} FindClose
FindClose \e{handle}
\c handle
Closes a search opened with FindFirst.
Closes a search opened with FindFirst.
\H{FindFirst} FindFirst
FindFirst \e{user_var(handle output) user_var(filename output) filespec}
\c user_var(handle output) user_var(filename output) filespec
Performs a search for 'filespec', placing the first file found in filename_output (a user variable). It also puts the handle of the search into handle_output (also a user variable). If no files are found, both outputs are set to empty, and the error flag is set. Best used with FindNext and FindClose. Note that the filename output is without path.
Performs a search for 'filespec', placing the first file found in filename_output (a user variable). It also puts the handle of the search into handle_output (also a user variable). If no files are found, both outputs are set to empty, and the error flag is set. Best used with FindNext and FindClose. Note that the filename output is without path.
\H{FindNext} FindNext
FindNext \e{handle user_var(filename_output)}
\c handle user_var(filename_output)
Continues a search began with FindFirst. handle should be the handle_output_variable returned by FindFirst. If the search is completed (there are no more files), filename_output is set to empty, and the error flag is set. Note that the filename output is without path.
Continues a search began with FindFirst. handle should be the handle_output_variable returned by FindFirst. If the search is completed (there are no more files), filename_output is set to empty, and the error flag is set. Note that the filename output is without path.