documentation for new predefines

git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@4911 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
kichik 2007-01-27 16:26:46 +00:00
parent e8f7406c59
commit c33f7c361b

View file

@ -178,6 +178,142 @@ Time when the script started compiling according to the current locale.
Date & time of the last modification to the script file according to the current locale.
\S1{} Scope Predefines
Standard predefines that contain information of the current code scope.
\S2{} $\{__GLOBAL__\}
Defined in the global scope.
\c Section test
\c
\c !ifdef ${__GLOBAL__}
\c !error "this shouldn't be here!"
\c !endif
\c
\c SectionEnd
\c
\c Function test
\c
\c !ifdef ${__GLOBAL__}
\c !error "this shouldn't be here!"
\c !endif
\c
\c FunctionEnd
\c
\c PageEx instfiles
\c
\c !ifdef ${__GLOBAL__}
\c !error "this shouldn't be here!"
\c !endif
\c
\c PageExEnd
\S2{} $\{__SECTION__\}
Defined as the section name, without any prefixes, in \R{ssection}{section} scope.
\c !ifdef __SECTION__
\c !error "this shouldn't be here!"
\c !endif
\c
\c Section test
\c
\c !ifndef __SECTION__
\c !error "missing predefine!"
\c !endif
\c
\c !if ${__SECTION__} != test
\c !error "wrong predefine value!"
\c !endif
\c
\c SectionEnd
\c
\c Section !test
\c
\c !if ${__SECTION__} != test
\c !error "wrong predefine value!"
\c !endif
\c
\c SectionEnd
\c
\c Section un.test
\c
\c !if ${__SECTION__} != test
\c !error "wrong predefine value!"
\c !endif
\c
\c SectionEnd
\S2{} $\{__FUNCTION__\}
Defined as the function name, without any prefixes, in \R{ffunction}{function} scope.
\c !ifdef __FUNCTION__
\c !error "this shouldn't be here!"
\c !endif
\c
\c Function test
\c
\c !ifndef __FUNCTION__
\c !error "missing predefine!"
\c !endif
\c
\c !if ${__FUNCTION__} != test
\c !error "wrong predefine value!"
\c !endif
\c
\c FunctionEnd
\c
\c Function un.test
\c
\c !if ${__FUNCTION__} != test
\c !error "wrong predefine value!"
\c !endif
\c
\c FunctionEnd
\S2{} $\{__PAGEEX__\}
Defined in \R{pageex}{PageEx} scope.
\c !ifdef __PAGEEX__
\c !error "this shouldn't be here!"
\c !endif
\c
\c PageEx instfiles
\c
\c !ifndef __PAGEEX__
\c !error "missing predefine!"
\c !endif
\c
\c PageExEnd
\S2{} $\{__UNINSTALL__\}
Defined in \R{ssection}{section}, \R{ffunction}{function} or \R{pageex}{PageEx} scopes of the uninstaller.
\c !ifdef __UNINSTALL__
\c !error "this shouldn't be here!"
\c !endif
\c
\c Function test
\c
\c !ifdef __UNINSTALL__
\c !error "this shouldn't be here!"
\c !endif
\c
\c FunctionEnd
\c
\c Function un.test
\c
\c !ifndef __UNINSTALL__
\c !error "missing predefine!"
\c !endif
\c
\c FunctionEnd
\S0{compenvvarread} Read environment variables
\S1{compenvvar} $%envVarName%