NSIs commonly used callback functions
NSIs commonly used callback functions Onguiinit onInit oninstfailed oninstsuccess onguiend onmouseoversection onrebootfailed onselchange Onuserabort onverifyinstdir unguiinit unoninit unonuninstfailed unonuninstsuccess unonGUIEnd unonRebootFailed Unonuserabort
Note: For specific use examples, see the Nsis.chm Help documentation Onguiinit:
The callback will be called before the first page is loaded and the Installer dialog box is displayed, allowing you to adjust the user interface. OnInit:
The callback will be called when the Setup program is nearing completion of initialization. If the. OnInit function calls Abort, the installer exits immediately. oninstfailed:
The callback function is called when the user taps the Cancel button after the installation fails (if the installer cannot release any files, or if the installation script uses the Abort command). oninstsuccess:
This callback is invoked when the installation is successful and the installation window is closed (if Autoclosewindow or Setautoclose is set to False when the user taps "close"). Onguiend:
The callback is called after the installer window is closed. Use to release any plugins related to the user interface when needed. onmouseoversection:
This callback is called whenever the mouse moves over the tree section selection box. This allows you to set a sample description for each section. The current section ID of the mouse cursor has been saved temporarily. onrebootfailed:
The callback function is called when the Reboot instruction fails. Writeuninstaller, Plug-ins, File, and Writeregbin cannot be used for this callback function. Onselchange:
Called when the Component Selection page option is changed. Often used with sectionsetflags and sectiongetflags. Onuserabort:
This callback is called when the user taps the Cancel button and the installation has not yet failed. If the function calls Abort, the installation will not exit. Onverifyinstdir:
This callback is for your installer to allow you to control whether the installation path is valid. This code will be called once each time the user changes the installation path. If the function calls Abort, the path $INSTDIR is considered invalid. un. Guiinit:
The callback will be called before the first page is loaded and the Uninstaller dialog box is displayed, allowing you to adjust the interface of the uninstall program. Un.oninit:
The callback will be called when the uninstaller is nearing completion of initialization. If the Un.oninit function uses Abort, the uninstaller exits immediately. Note that the function can validate and/or modify $INSTDIR if needed. un.onuninstfailed:
The callback function is called when the user taps the Cancel button when the uninstallation fails (if the Abort command or other failed command is used). un.onuninstsuccess:
The callback is invoked when the uninstallation succeeds and the Uninstaller window is closed (if Setautoclose is set to False when the user taps "close"). Un.onguiend:
The callback is invoked just after the uninstaller window is closed. Use to release any plugins related to the user interface when needed. un.onrebootfailed:
The callback function is called when the Reboot instruction fails. Writeuninstaller, Plug-ins, File, and Writeregbin cannot be used for this callback function. Un.onuserabort:
This callback is called when the user taps the Cancel button and the uninstallation has not yet failed. If the function calls Abort, the uninstaller does not exit.