Useful Information

Previous | Contents | Next

- Appendix D: Useful Information

- Error Levels
- Add uninstall information to Add/Remove Programs
- Calling an external DLL using the System.dll plug-in
- Dump Content of Log Window to File
- How to Read REG_MULTI_SZ Values
- Predefined Macros for Unicode support

# Appendix D: Useful Information

## D.1 Error Levels

Like other applications, installers made by NSIS return error levels as a result of their execution. Checking the error level can be useful if you call an NSIS installer from another application or installer.

- 0 - Normal execution (no error)
- 1 - Installation aborted by user (cancel button)
- 2 - Installation aborted by script

You can set the error level to other values using SetErrorLevel.

Note that uninstallers copy themselves to the temporary directory and execute from there so the original uninstaller can be deleted. This means the error level the uninstaller sets is not available to the executing process, unless it simulates this copy process and executes the copied uninstaller. To simulate this process, use:

    InitPluginsDir
    CopyFiles $INSTDIR\uninstaller.exe $PLUGINSDIR
    ExecWait '"$PLUGINSDIR\uninstaller.exe" _?=$INSTDIR' $0
    DetailPrint "uninstaller set error level $0"

If you don't do this, you'll only be able to know if the uninstaller failed copying itself to the temporary directory.

## D.2 Add uninstall information to Add/Remove Programs

Create a key with your product name (or a GUID) under HKLM\Software\Microsoft\Windows\CurrentVersion\Uninstall to add entries to the "Add/Remove Programs" section in the Control Panel. For Windows NT (NT4/2000/XP and later), it's also possible to create the key in the HKCU hive, so it will only appear for the current user. There are several values you can write to key to give information about your application and the uninstaller. Write a value using the WriteRegStr command (for strings) or WriteRegDWORD command (for DWORD values).

Example:

    WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\MyProduct" "DisplayName" "Application Name"
    WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\MyProduct" "UninstallString" '"$INSTDIR\uninst.exe"'

Required values:

DisplayName (string) - Name of the application
UninstallString (string) - Path and filename of the uninstaller. You should always quote the path.

Optional values:

Some of the following values will not be used by older Windows versions.

QuietUninstallString (string) - Quiet uninstall command (`"$INSTDIR\uninst.exe" /S`)

InstallLocation (string) - Installation directory ($INSTDIR)
DisplayIcon (string) - Path, filename and index of the icon that will be displayed next to your application name

Publisher (string) - (Company) name of the publisher

ModifyPath (string) - Path and filename of the application modify program
InstallSource (string) - Location where the application was installed from

ProductID (string) - Product ID of the application
RegOwner (string) - Registered owner of the application
RegCompany (string) - Registered company of the application

HelpLink (string) - Link to the support website
HelpTelephone (string) - Telephone number for support

URLUpdateInfo (string) - Link to the website for application updates
URLInfoAbout (string) - Link to the application home page

DisplayVersion (string) - Displayed version of the application
VersionMajor (DWORD) - Major version number of the application
VersionMinor (DWORD) - Minor version number of the application

NoModify (DWORD) - 1 if uninstaller has no option to modify the installed application
NoRepair (DWORD) - 1 if the uninstaller has no option to repair the installation

If both NoModify and NoRepair are set to 1, the button displays "Remove" instead of "Modify/Remove".

## D.3 Calling an external DLL using the System.dll plug-in

Some installers need to call functions in third-party DLLs. A prime example of this is when installing a Palm(TM) conduit.

Some background about System.dll
The System.dll plug-in enables calling of external DLLs by using its 'Call' function. There are a number of other functions provided by System.dll but they will not be covered here. For more details about the other functions, lock the doors, take the phone off the hook, screw your head on *real* tight and head on over to the System readme.

Data Types
System.dll recognises the following data types:

- v - void (generally for return)
- p - pointer (includes void*, HANDLE, HWND, UINT_PTR and so on)
- i - int (a 32bit integer)
- l - large integer (also known as int64)
- t - text, string (LPTSTR, pointer to first character)
- k - callback. See Callback section in system.html.
- * - pointer specifier -> the proc needs the pointer to type, affects next char (parameter) [ex: '*i' - pointer to int]

Mapping System.dll variables to NSIS script variables
There's not much point in being able to call an external function if you can't get any data back. System.dll maps function variables to NSIS script variables in the following way:

NSIS $0..$9 becomes System.dll r0..r9 NSIS $R0..$R9 becomes System.dll r10..r19

Each parameter is specified by type, input and output. To skip input or output use a dot. Examples:

String (pointer to a character array), input is 'happy calling':

    t 'happy calling'

String (pointer to a character array), input is taken from $5 and changes to the array made by the callee are saved into $R8:

    t r5R8

Pointer to an integer, value taken from $1 and put into $2:

    *i r1r2

Pointer to a 64-bit integer, output pushed on stack, no input:

    *l .s

Using System.dll::Call To call a function in a third party DLL, the Call function is used like this:

    System::Call 'YourDllName::YourDllFunction(i, *i, t) i(r0, .r1, r2) .r3'

The '(r0, .r1, r2) .r3' section at the end are the parameters that are passed between your DLL and your NSIS script. As can be seen in this parameters list, type and input/output can be separated. Each block of "(parms list) return value" overrides and/or adds to the last one. In this case, the first block specifies the types and the second specifies input and output.

Before starting to code the NSIS script
Before you start to code any NSIS code you need to know the full prototype of the function you are going to call. For the purposes of this example, we will use the 'CmGetHotSyncExecPath' function from the Palm 'CondMgr.dll'. This function is used to return the full path of 'HotSync.exe'.

Function Definition

int __stdcall CmGetHotSyncExecPath(TCHAR *pPath, int *piSize);

where

- pPath is a pointer to a character buffer. Upon return, this is the path & file name of the installed HotSync manager.
- piSize is a pointer to an integer that specifies the size (in TCHAR's), of the buffer referenced by the pPath parameter.

return values:

- 0: No error
- -1: A non-specific error occurred
- ERR_REGISTRY_ACCESS(-1006):Unable to access the Palm configuration entries
- ERR_BUFFER_TOO_SMALL(-1010): The buffer is too small to hold the requested information
- ERR_INVALID_POINTER(-1013):The specified pointer is not a valid pointer

Also, if the buffer is too small the value in *int is the size (in TCHARs) that the buffer should be.

This function definition maps to the following System.dll definition:

CmGetHotSyncExecPath(t, *i) i

i.e. It takes a text variable, a pointer to int, and returns an int value.

Using the external dll function
Now that we've sorted out what the function does and how it maps to the System.dll format we can use the function in a NSIS script.

First you have to change the output directory to that where the DLL you want to use is. It may also work if the DLL is in the system path but this hasn't been tested.

The following code fragment will install 'condmgr.dll' to a temporary directory, execute the CmGetHotSyncExecPath function and display returned data. Save this script

    Function loadDll

      SetOutPath $TEMP\eInspect             ; create temp directory
      File bin\CondMgr.dll                  ; copy dll there
      StrCpy $1 ${NSIS_MAX_STRLEN}          ; assign memory to $0
      System::Call 'CondMgr::CmGetHotSyncExecPath(t, *i) i(.r0, r1r1).r2'
      DetailPrint 'Path: "$0"'
      DetailPrint "Path length: $1"
      DetailPrint "Return value: $2"

    FunctionEnd

and this function produces the following output in the 'details' page:

Output folder: c:\windows\TEMP\eInspect
Extract: CondMgr.dll
Path: "C:\Dave\palm\Hotsync.exe"
Path length: 24
Return value: 0

Written by djc

## D.4 Dump Content of Log Window to File

This function will dump the log of the installer (installer details) to a file of your choice.

To use it, push a file name and call it. It will dump the log to the file specified. For example:

    GetTempFileName $0
    DetailPrint "Writing log to $0"
    Push $0
    Call DumpLog

If you're building a Unicode installer you can `!define DumpLog_As_UTF16LE` to output as UTF-16LE or `!define DumpLog_As_UTF16LE "/BOM"` to output as UTF-16LE with a BOM.

Here is the function:

    !define /IfNDef LVM_GETITEMCOUNT 0x1004
    !define /IfNDef LVM_GETITEMTEXTA 0x102D
    !define /IfNDef LVM_GETITEMTEXTW 0x1073
    !if "${NSIS_CHAR_SIZE}" > 1
    !define /IfNDef LVM_GETITEMTEXT ${LVM_GETITEMTEXTW}
    !else
    !define /IfNDef LVM_GETITEMTEXT ${LVM_GETITEMTEXTA}
    !endif

    Function DumpLog
      Exch $5
      Push $0
      Push $1
      Push $2
      Push $3
      Push $4
      Push $6
      FindWindow $0 "#32770" "" $HWNDPARENT
      GetDlgItem $0 $0 1016
      StrCmp $0 0 exit
      FileOpen $5 $5 "w"
      StrCmp $5 "" exit
        SendMessage $0 ${LVM_GETITEMCOUNT} 0 0 $6
        System::Call '*(&t${NSIS_MAX_STRLEN})p.r3'
        StrCpy $2 0
        System::Call "*(i, i, i, i, i, p, i, i, i) i  (0, 0, 0, 0, 0, r3, ${NSIS_MAX_STRLEN}) .r1"
        loop: StrCmp $2 $6 done
          System::Call "User32::SendMessage(i, i, i, i) i ($0, ${LVM_GETITEMTEXT}, $2, r1)"
          System::Call "*$3(&t${NSIS_MAX_STRLEN} .r4)"
          !ifdef DumpLog_As_UTF16LE
          FileWriteUTF16LE ${DumpLog_As_UTF16LE} $5 "$4$\r$\n"
          !else
          FileWrite $5 "$4$\r$\n" ; Unicode will be translated to ANSI!
          !endif
          IntOp $2 $2 + 1
          Goto loop
        done:
          FileClose $5
          System::Free $1
          System::Free $3
      exit:
        Pop $6
        Pop $4
        Pop $3
        Pop $2
        Pop $1
        Pop $0
        Pop $5
    FunctionEnd

## D.5 How to Read REG_MULTI_SZ Values

This example reads a registry value of the type REG_MULTI_SZ and prints it out. Don't forget to edit where it says "Edit this!" when you test this script. The values must point to a REG_MULTI_SZ value or the example will spit out an error.

    OutFile "REG_MULTI_SZ Reader.exe"
    Name "REG_MULTI_SZ Reader"
    ShowInstDetails show

    !define HKEY_CLASSES_ROOT        0x80000000
    !define HKEY_CURRENT_USER        0x80000001
    !define HKEY_LOCAL_MACHINE       0x80000002
    !define HKEY_USERS               0x80000003
    !define HKEY_PERFORMANCE_DATA    0x80000004
    !define HKEY_PERFORMANCE_TEXT    0x80000050
    !define HKEY_PERFORMANCE_NLSTEXT 0x80000060
    !define HKEY_CURRENT_CONFIG      0x80000005
    !define HKEY_DYN_DATA            0x80000006
    !define KEY_QUERY_VALUE          0x0001
    !define KEY_ENUMERATE_SUB_KEYS   0x0008
    !define REG_NONE                 0
    !define REG_SZ                   1
    !define REG_EXPAND_SZ            2
    !define REG_BINARY               3
    !define REG_DWORD                4
    !define REG_DWORD_LITTLE_ENDIAN  4
    !define REG_DWORD_BIG_ENDIAN     5
    !define REG_LINK                 6
    !define REG_MULTI_SZ             7

    !define RegOpenKeyEx     "Advapi32::RegOpenKeyEx(p, t, i, i, *p) i"
    !define RegQueryValueEx  "Advapi32::RegQueryValueEx(p, t, p, *i, p, *i) i"
    !define RegCloseKey      "Advapi32::RegCloseKeyA(p) i"

    ####### Edit this!

    !define ROOT_KEY         ${HKEY_LOCAL_MACHINE}
    !define SUB_KEY          "SYSTEM\CurrentControlSet\Control\Lsa"
    !define VALUE            "Security Packages"

    ####### Stop editing

    Section "Read"
      StrCpy $1 ""
      StrCpy $2 ""
      StrCpy $3 ""
      System::Call "${RegOpenKeyEx}(${ROOT_KEY}, '${SUB_KEY}', \
        0, ${KEY_QUERY_VALUE}|${KEY_ENUMERATE_SUB_KEYS}, 0 r0) .r3"

      StrCmp $3 0 goon
        MessageBox MB_OK|MB_ICONSTOP "Can't open registry key! ($3)"
        Goto done
    goon:

      System::Call "${RegQueryValueEx}(r0, '${VALUE}', 0, .r1, 0, .r2) .r3"

      StrCmp $3 0 read
        MessageBox MB_OK|MB_ICONSTOP "Can't query registry value size! ($3)"
        Goto done

    read:

      StrCmp $1 ${REG_MULTI_SZ} multisz
        MessageBox MB_OK|MB_ICONSTOP "Registry value not a REG_MULTI_SZ! ($3)"
        Goto done

    multisz:

      StrCmp $2 0 0 multiszalloc
        MessageBox MB_OK|MB_ICONSTOP "Registry value empty! ($3)"
        Goto done

    multiszalloc:

      System::Alloc $2
      Pop $1

      StrCmp $1 0 0 multiszget
        MessageBox MB_OK|MB_ICONSTOP "Can't allocate enough memory! ($3)"
        Goto done

    multiszget:

      System::Call "${RegQueryValueEx}(r0, '${VALUE}', 0, n, r1, r2) .r3"

      StrCmp $3 0 multiszprocess
        MessageBox MB_OK|MB_ICONSTOP "Can't query registry value data! ($3)"
        Goto done

    multiszprocess:

      StrCpy $4 $1

      loop:

        System::Call "*$4(&t${NSIS_MAX_STRLEN} .r3)"
        StrCmp $3 "" done
        DetailPrint $3
        StrLen $5 $3
        !if "${NSIS_CHAR_SIZE}" > 1
        IntOp $5 $5 * ${NSIS_CHAR_SIZE}
        !endif
        IntPtrOp $4 $4 + $5
        IntPtrOp $4 $4 + ${NSIS_CHAR_SIZE}
        Goto loop

    done:

      System::Free $1

      StrCmp $0 0 noClose
        System::Call "${RegCloseKey}(r0)"

    noClose:

    SectionEnd

## D.6 Predefined Macros for Unicode support

There are two macros that can help you write scripts that work for both Unicode and ANSI installers. To figure out if the script is being compiled to generate a Unicode installer, use !ifdef to check for NSIS_UNICODE. To see what the size of a character is, use ${NSIS_CHAR_SIZE}. It will be 1 for ANSI and 2 for Unicode installers.

Previous | Contents | Next