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

applied patch #3307144 - more cross links in documentation (whyeye)

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@6152 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik 2011-05-28 18:45:57 +00:00
parent b39f193c31
commit 041a8a9881
20 changed files with 146 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Docs/src/file.but
View file

@ -4,7 +4,7 @@
\c handle
Closes a file handle opened with FileOpen.
Closes a file handle opened with \R{FileOpen}{FileOpen}.
\S2{FileOpen} FileOpen
@ -21,7 +21,7 @@ If no absolute path is specified the current folder will be used. The current fo
\c handle user_var(output) [maxlen]
Reads a string (ANSI characters) 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). By default, strings are limited to 1024 characters (a special build with larger NSIS_MAX_STRLEN can be compiled or downloaded). 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 (ANSI characters) from a file opened with \R{FileOpen}{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). By default, strings are limited to 1024 characters (a special build with larger NSIS_MAX_STRLEN can be compiled or downloaded). 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.
(If you are building a \R{intro-unicode}{Unicode installer}, the function reads an ANSI string and makes the adequate conversion)
@ -39,7 +39,7 @@ Reads a string (ANSI characters) from a file opened with FileOpen. The string is
This function is only available when building a \R{intro-unicode}{Unicode installer}.
Reads a string (UTF-16LE characters) from a file opened with FileOpen. The string is read until either a newline (or carriage return newline pair) occurs, or until a null wide-character is read, or until maxlen is met (if specified). By default, strings are limited to 1024 characters (a special build with larger NSIS_MAX_STRLEN can be compiled or downloaded). 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 (UTF-16LE characters) from a file opened with \R{FileOpen}{FileOpen}. The string is read until either a newline (or carriage return newline pair) occurs, or until a null wide-character is read, or until maxlen is met (if specified). By default, strings are limited to 1024 characters (a special build with larger NSIS_MAX_STRLEN can be compiled or downloaded). 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.
\c ClearErrors
\c FileOpen $0 $INSTDIR\file.dat r
@ -53,7 +53,7 @@ Reads a string (UTF-16LE characters) from a file opened with FileOpen. The strin
\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 \R{FileOpen}{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.
\c ClearErrors
\c FileOpen $0 $INSTDIR\file.dat r
@ -70,7 +70,7 @@ Reads a byte from a file opened with FileOpen. The byte is stored in the output
This function is only available when building a \R{intro-unicode}{Unicode installer}.
Reads a word (2-bytes) from a file opened with FileOpen. The word is stored in the output as an integer (0-65535). 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 word (2-bytes) from a file opened with \R{FileOpen}{FileOpen}. The word is stored in the output as an integer (0-65535). 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.
\c ClearErrors
\c FileOpen $0 $INSTDIR\file.dat r
@ -85,7 +85,7 @@ Reads a word (2-bytes) from a file opened with FileOpen. The word is stored in t
\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", relative to the beginning of the file. If mode is specified as CUR, then the file is positioned to "offset", relative to the current file position. If mode is specified as END, then the file is positioned to "offset", relative to the end of the file. If the final parameter "new position" is specified, the new file position will be stored to that variable.
Seeks a file opened with \R{FileOpen}{FileOpen}. If mode is omitted or specified as SET, the file is positioned to "offset", relative to the beginning of the file. If mode is specified as CUR, then the file is positioned to "offset", relative to the current file position. If mode is specified as END, then the file is positioned to "offset", relative to the end of the file. If the final parameter "new position" is specified, the new file position will be stored to that variable.
\c ClearErrors
\c FileOpen $0 $INSTDIR\file.dat r
@ -100,7 +100,7 @@ Seeks a file opened with FileOpen. If mode is omitted or specified as SET, the f
\c handle string
Writes an ANSI string to a file opened with FileOpen. If an error occurs writing, the error flag will be set.
Writes an ANSI string to a file opened with \R{FileOpen}{FileOpen}. If an error occurs writing, the error flag will be set.
(If you are building a \R{intro-unicode}{Unicode installer}, the function makes the adequate conversion and writes an ANSI string)
@ -117,7 +117,7 @@ Writes an ANSI string to a file opened with FileOpen. If an error occurs writing
This function is only available when building a \R{intro-unicode}{Unicode installer}.
Writes a Unicode (UTF-16LE) string to a file opened with FileOpen. If an error occurs writing, the error flag will be set.
Writes a Unicode (UTF-16LE) string to a file opened with \R{FileOpen}{FileOpen}. If an error occurs writing, the error flag will be set.
\c ClearErrors
\c FileOpen $0 $INSTDIR\file.dat w
@ -130,7 +130,7 @@ Writes a Unicode (UTF-16LE) string to a file opened with FileOpen. If an error o
\c handle string
Writes the integer interpretation of 'string' to a file opened with FileOpen. Of course you can enter the integer value directly. The following code writes a "Carriage Return / Line Feed" - Enter to the file.
Writes the integer interpretation of 'string' to a file opened with \R{FileOpen}{FileOpen}. Of course you can enter the integer value directly. The following code writes a "Carriage Return / Line Feed" - Enter to the file.
\c FileWriteByte file_handle "13"
\c FileWriteByte file_handle "10"
@ -143,7 +143,7 @@ If an error occurs while writing, the error flag will be set. Note that the low
This function is only available when building a \R{intro-unicode}{Unicode installer}.
Writes the integer interpretation of 'string' as a WORD (2-bytes, range: 0-65535) to a file opened with FileOpen. Of course you can enter the integer value directly. The following code writes a "Carriage Return / Line Feed" - Enter to the file.
Writes the integer interpretation of 'string' as a WORD (2-bytes, range: 0-65535) to a file opened with \R{FileOpen}{FileOpen}. Of course you can enter the integer value directly. The following code writes a "Carriage Return / Line Feed" - Enter to the file.
\c FileWriteWord file_handle "13"
\c FileWriteWord file_handle "10"
@ -154,13 +154,13 @@ If an error occurs while writing, the error flag will be set. Note that the low
\c handle
Closes a search opened with FindFirst.
Closes a search opened with \R{FindFirst}{FindFirst}.
\S2{FindFirst} FindFirst
\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 \R{FindNext}{FindNext} and \R{FindClose}{FindClose}. Note that the filename output is without path.
\c FindFirst $0 $1 $INSTDIR\*.txt
\c loop:
@ -175,4 +175,4 @@ Performs a search for 'filespec', placing the first file found in filename_outpu
\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 \R{FindFirst}{FindFirst}. handle should be the handle_output_variable returned by \R{FindFirst}{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.