9a47586141
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@7196 212acab6-be3b-0410-9dea-997c60f758d6
283 lines
9.5 KiB
Text
283 lines
9.5 KiB
Text
\A{library} DLL/TLB Library Setup
|
|
|
|
|
|
\H{library_intro} Introduction
|
|
|
|
The Library header file can be used to setup dynamic link libraries (DLL) and type libraries (TLB).
|
|
If necessary, the following actions will be performed:
|
|
|
|
\b File copying
|
|
|
|
\b File copying on reboot
|
|
|
|
\b Version checks
|
|
|
|
\b Registration and unregistration
|
|
|
|
\b Registration and unregistration on reboot
|
|
|
|
\b Shared DLL counting
|
|
|
|
\b Windows File Protection checks
|
|
|
|
The macros are stored in the header file Library.nsh, which should be included in scripts using this system:
|
|
|
|
\c !include Library.nsh
|
|
|
|
Note that the library macros are limited on non-Windows platforms. DLL version information is required when compiling on non-Windows platforms.
|
|
|
|
|
|
\H{library_install} Library Installation
|
|
|
|
\S1{} Introduction
|
|
|
|
The InstallLib macro allows you to install a library. It sets the error flag if something went wrong during library setup.
|
|
|
|
To ask the user for a reboot, if required, use the Modern UI with a Finish page or use \R{ifrebootflag}{IfRebootFlag} and make your own page or message box.
|
|
|
|
\S1{library_install_parameters} Parameters
|
|
|
|
\c libtype shared install localfile destfile tempbasedir
|
|
|
|
\\<b\\>libtype\\</b\\>
|
|
|
|
The type of the library
|
|
|
|
DLL - Dynamic link library (DLL)\\<br\\>
|
|
REGDLL - DLL that has to be registered\\<br\\>
|
|
REGEXE - EXE COM server that has to be registered using /regserver\\<br\\>
|
|
TLB - Type library or DLL that contains a type library\\<br\\>
|
|
REGDLLTLB - DLL that has to be registered and contains a type library\\<br\\>
|
|
|
|
|
|
\\<b\\>shared\\</b\\>
|
|
|
|
Specify whether the library is shared with other applications
|
|
|
|
NOTSHARED - The library is not shared\\<br\\>
|
|
$VARNAME - Variable that is empty when the application is installed for the first time,
|
|
which is when the shared library count will be increased.\\<br\\>
|
|
|
|
\\<b\\>install\\</b\\>
|
|
|
|
Specify the installation method
|
|
|
|
REBOOT_PROTECTED
|
|
|
|
\b Upgrade the library on reboot when in use (required for system files).
|
|
|
|
\b Upgrade the library if the file is not protected by Windows File Protection.
|
|
|
|
NOREBOOT_PROTECTED
|
|
|
|
\b Warns the user when the library is in use. The user will have to close applications using the library.
|
|
|
|
\b Upgrade the library if the file is not protected by Windows File Protection.
|
|
|
|
REBOOT_NOTPROTECTED
|
|
|
|
\b Upgrade the library on reboot when in use (required for system files).
|
|
|
|
\b Upgrade the library without checking for Windows File Protection.
|
|
|
|
NOREBOOT_NOTPROTECTED
|
|
|
|
\b Warns the user when the library is in use. The user will have to close applications using the library.
|
|
|
|
\b Upgrade the library without checking for Windows File Protection.
|
|
|
|
\\<b\\>localfile\\</b\\>
|
|
|
|
Location of the library on the compiler system
|
|
|
|
\\<b\\>destfile\\</b\\>
|
|
|
|
Location to store the library on the user's system
|
|
|
|
\\<b\\>tempbasedir\\</b\\>
|
|
|
|
Directory on the user's system to store a temporary file when the system has to be rebooted.
|
|
|
|
For Windows 9x/ME support, this directory should be on the same volume as the destination file (destfile).
|
|
The Windows temp directory could be located on any volume, so you cannot use this directory.
|
|
|
|
\S1{library_install_options} Options
|
|
|
|
\R{define}{Define} any of the following before inserting a InstallLib macro to modify its behavior as specified.
|
|
|
|
\S2{} LIBRARY_X64
|
|
|
|
\b Installs a DLL built for Windows x64.
|
|
|
|
\b \\<b\\>Warning:\\</b\\> This resets \R{setregview}{SetRegView} and file system redirection.
|
|
|
|
\S2{} LIBRARY_SHELL_EXTENSION
|
|
|
|
\b Define this before inserting InstallLib macro to call SHChangeNotify with SHCNE_ASSOCCHANGED after registration.
|
|
|
|
\b Use this to refresh the shell when installing a shell extension or when changing file associations.
|
|
|
|
\S2{} LIBRARY_COM
|
|
|
|
\b Define this before inserting InstallLib macro to call CoFreeUnusedLibraries after registration.
|
|
|
|
\b Use this for unloading all unnecessary libraries from memory when installing COM libraries.
|
|
|
|
\S2{} LIBRARY_IGNORE_VERSION
|
|
|
|
\b Define this before inserting InstallLib macro to ignore version information in the file and always install it, even if it already exists.
|
|
|
|
\b Use this when an older or specific version is required.
|
|
|
|
\b Not recommended for DLLs installed to $SYSDIR.
|
|
|
|
\S2{} LIBRARY_INSTALL_EQUAL_VERSION
|
|
|
|
\b Define this before inserting InstallLib macro to overwrite the file even if the version is the same as the existing file.
|
|
|
|
\S1{library_install_notes} Notes
|
|
|
|
\b If you need to support Windows 9x/ME, you can only use short filenames (8.3).
|
|
|
|
\b \\<b\\>Warning:\\</b\\> Always use redistributable files when deploying DLLs, never copy files from your system directory!
|
|
|
|
\S1{library_install_examples} Example
|
|
|
|
\S2{} Unshared DLL
|
|
|
|
\c !insertmacro InstallLib REGDLL NOTSHARED REBOOT_NOTPROTECTED dllname.dll $SYSDIR\dllname.dll $SYSDIR
|
|
|
|
\S2{} Shared DLL
|
|
|
|
\c ;Add code here that sets $ALREADY_INSTALLED to a non-zero value if the application is
|
|
\c ;already installed. For example:
|
|
\c
|
|
\c IfFileExists "$INSTDIR\MyApp.exe" 0 new_installation ;Replace MyApp.exe with your application filename
|
|
\c StrCpy $ALREADY_INSTALLED 1
|
|
\c new_installation:
|
|
\c
|
|
\c !insertmacro InstallLib REGDLL $ALREADY_INSTALLED REBOOT_NOTPROTECTED dllname.dll $SYSDIR\dllname.dll $SYSDIR
|
|
|
|
\H{library_uninstall} Library Uninstallation
|
|
|
|
\S1{} Introduction
|
|
|
|
The UnInstallLib macro allows you to uninstall a library. It sets the error flag if something went wrong during library removal.
|
|
|
|
\S1{library_uninstall_parameters} Parameters
|
|
|
|
\c libtype shared uninstall file
|
|
|
|
\\<b\\>libtype\\</b\\>
|
|
|
|
The type of the library
|
|
|
|
DLL - Dynamic link library (DLL)\\<br\\>
|
|
REGDLL - DLL that has to be unregistered\\<br\\>
|
|
REGEXE - EXE COM server that has to be unregistered using /unregserver\\<br\\>
|
|
TLB - Type library or DLL that contains a type library\\<br\\>
|
|
REGDLLTLB - DLL that has to be unregistered and contains a type library\\<br\\>
|
|
|
|
|
|
\\<b\\>shared\\</b\\>
|
|
|
|
Specify whether the library is shared with other applications
|
|
|
|
NOTSHARED - The library is not shared\\<br\\>
|
|
SHARED - The library is shared and should be removed if the shared library count
|
|
indicates that the file is not in use anymore..\\<br\\>
|
|
|
|
\\<b\\>uninstall\\</b\\>
|
|
|
|
Specify the uninstallation method
|
|
|
|
NOREMOVE
|
|
|
|
\b The library should not be removed. You should use this option for common or important
|
|
system files such as the Visual Basic/C++/MFC runtimes.
|
|
|
|
REBOOT_PROTECTED
|
|
|
|
\b Remove the library on reboot when in use (required for system files).
|
|
|
|
\b Remove the library if the file is not protected by Windows File Protection.
|
|
|
|
NOREBOOT_PROTECTED
|
|
|
|
\b Warns the user when the library is in use. The user will have to close applications using the library.
|
|
|
|
\b Remove the library if the file is not protected by Windows File Protection.
|
|
|
|
REBOOT_NOTPROTECTED
|
|
|
|
\b Remove the library on reboot when in use (required for system files).
|
|
|
|
\b Remove the library without checking for Windows File Protection.
|
|
|
|
NOREBOOT_NOTPROTECTED
|
|
|
|
\b Warns the user when the library is in use. The user will have to close applications using the library.
|
|
|
|
\b Remove the library without checking for Windows File Protection.
|
|
|
|
|
|
\\<b\\>file\\</b\\>
|
|
|
|
Location of the library
|
|
|
|
\S1{library_uninstall_options} Options
|
|
|
|
\R{define}{Define} any of the following before inserting a UnInstallLib macro to modify its behavior as specified.
|
|
|
|
\S2{} LIBRARY_X64
|
|
|
|
\b Uninstalls a DLL built for Windows x64.
|
|
|
|
\b \\<b\\>Warning:\\</b\\> This resets \R{setregview}{SetRegView} and file system redirection.
|
|
|
|
\S2{} LIBRARY_SHELL_EXTENSION
|
|
|
|
\b Define this before inserting UninstallLib macro to call SHChangeNotify with SHCNE_ASSOCCHANGED after unregistration. Use this to refresh the shell when uninstalling a shell extension or when changing file associations.
|
|
|
|
\S2{} LIBRARY_COM
|
|
|
|
\b Define this before inserting UninstallLib macro to call CoFreeUnusedLibraries after unregistration. Use this for unloading all unnecessary libraries from memory when uninstalling COM libraries.
|
|
|
|
\S1{library_uninstall_examples} Example
|
|
|
|
\c !insertmacro UnInstallLib REGDLL SHARED REBOOT_NOTPROTECTED $SYSDIR\dllname.dll
|
|
|
|
|
|
\H{library_vb6} Visual Basic 6 Run-Time Files
|
|
|
|
A new VB6RunTime.nsh header file is available for the setup of the VB6 run-time files.
|
|
To obtain the latest run-time files, download \W{https://nsis.sourceforge.io/vb6runtime.zip}{vb6runtime.zip} and extract this file.
|
|
|
|
\c !include VB6RunTime.nsh
|
|
\c
|
|
\c Var AlreadyInstalled
|
|
\c
|
|
\c Section "-Install VB6 run-time files"
|
|
\c
|
|
\c ;Add code here that sets $AlreadyInstalled to a non-zero value if the application is already installed. For example:
|
|
\c IfFileExists "$INSTDIR\MyApp.exe" 0 new_installation ;Replace MyApp.exe with your application filename
|
|
\c StrCpy $AlreadyInstalled 1
|
|
\c new_installation:
|
|
\c
|
|
\c !insertmacro VB6RunTimeInstall C:\vb6runtimes $AlreadyInstalled ;Replace C:\vb6runtimes with the location of the files
|
|
\c
|
|
\c SectionEnd
|
|
\c
|
|
\c Section "-un.Uninstall VB6 run-time files"
|
|
\c
|
|
\c !insertmacro VB6RunTimeUnInstall
|
|
\c
|
|
\c SectionEnd
|
|
|
|
Remarks:
|
|
|
|
\b You may have to install additional files for such Visual Basic application to work, such as OCX files for user interface controls.
|
|
|
|
\b Installation of the run-time files requires Administrator or Power User privileges. Use the Multi-User header file to verify whether these privileges are available.
|
|
|
|
\b Add a Modern UI finish page or another check (see \R{ifrebootflag}{IfRebootFlag}) to allow the user to restart the computer when necessary.
|