NSIS Wiki - User contributions [en]

Recursively remove empty parent directories

2013-12-05T01:17:02Z

550771955: /* Another function (by jiake) */

{{PageAuthor|ParallaxTZ}}

== Description ==

This function and example function call can be used to recursively delete empty parent folders of a given folder.

(Courtesy of the folks at [http://www.redbugtech.com Redbug Technologies] (www.redbugtech.com))

== The Script ==

<highlight-nsis>
Function un.RMDirUP
!define RMDirUP '!insertmacro RMDirUPCall'

!macro RMDirUPCall _PATH
push '${_PATH}'
Call un.RMDirUP
!macroend

; $0 - current folder
ClearErrors

Exch $0
;DetailPrint "ASDF - $0\.."
RMDir "$0\.."

IfErrors Skip
${RMDirUP} "$0\.."
Skip:

Pop $0
FunctionEnd
</highlight-nsis>

== Usage ==
The function declaration (as above) must appear before the call in the installation script.
<highlight-nsis>
RMDir /r "$INSTDIR" ;remove $INSTDIR and all files/subfolders
${RMDirUP} "$INSTDIR" ;remove $INSTDIR's parents (if each is empty ONLY)
</highlight-nsis>

== Another function (by jiake) ==

<highlight-nsis>
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
Push $R2
lbl_loop:
# Strip the last backslash
StrCpy $R1 $R0 "" -1
StrCmp $R1 "\" 0 +2
StrCpy $R0 $R0 -1
# Check if it is root path
StrCpy $R1 $R0 2
StrCmp $R1 $R0 lbl_end
# Check if it is empty
FindFirst $R1 $R2 "$R0\*.*"
lbl_dir:
StrCmp $R2 "." +2
StrCmp $R2 ".." 0 +3
FindNext $R1 $R2
Goto lbl_dir
FindClose $R1
# After skipping "." & ".."
StrCmp $R2 "" 0 lbl_end
# No more files found, it is an empty folder
RMDir $R0
# Get the parent folder and then loop
GetFullPathName $R0 "$R0\.."
Goto lbl_loop
lbl_end:
Pop $R2
Pop $R1
Pop $R0
FunctionEnd

/*
# Calling Windows API version
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
lbl_loop:
System::Call "shlwapi::PathAddBackslash(tR0R0)"
System::Call "shlwapi::PathIsRoot(tR0)i.R1"
StrCmp $R1 0 0 lbl_end
System::Call "shlwapi::PathIsDirectoryEmpty(tR0)i.R1"
StrCmp $R1 0 lbl_end
RMDir $R0
System::Call "shlwapi::PathAppend(tR0R0,ts)" ".."
Goto lbl_loop
lbl_end:
Pop $R1
Pop $R0
FunctionEnd
*/

Section -Test
# Create a temp direcotry
CreateDirectory "$TEMP\1\22\333\4444\55555"
# Remove empty directories recursively
Push "$TEMP\1\22\333\4444\55555"
Call RecursiveRemoveEmptyDirectory
SectionEnd
</highlight-nsis>

== Known issues ==
If a directory include more than one empty sub directories, this function fails.

[[Category:Disk, Path & File Functions]]

Check if the current user is an Administrator

2013-07-26T14:14:33Z

550771955: /* Macro 3 (Windows 2k or above) */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

There are 3 alternative implementations (2 macros and 1 function).

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

=== Macro 3 (Windows 2k or above) ===
I found that a Windows API can get the information of the specified user name, it's more easier than the above ways, I write it and so add it here. Any question please email jiake(at)vip.qq.com.
<highlight-nsis>
!define USER_PRIV_GUEST 0
!define USER_PRIV_USER 1
!define USER_PRIV_ADMIN 2

!include "Util.nsh"
!define GetUserLevel "!insertmacro Call_GetUserLevel"
!macro Call_GetUserLevel _level _username
!verbose push
!verbose 3
Push ${_username}
${CallArtificialFunction} Func_GetUserLevel
Pop ${_level}
!verbose pop
!macroend
!macro Func_GetUserLevel
Exch $R0
Push $R1
System::Call "*(i)i.R1"
System::Call "netapi32::NetUserGetInfo(in,wR0,i1,iR1)i.R0"
IntCmp $R0 0 +3
Push error
Goto lbl_end
System::Call "*$R1(i.R0)"
System::Call "*$R0(w,w,i,i.s)"
System::Call "netapi32::NetApiBufferFree(iR0)"
lbl_end:
System::Free $R1
Exch
Pop $R1
Exch
Pop $R0
!macroend
</highlight-nsis>
Usage example:
<highlight-nsis>
; ${GetUserLevel} VAR_USER_LEVEL_OUT STRING_OR_VAR_USERNAME
; STRING_OR_VAR_USERNAME:
; A valid username.
; VAR_USER_LEVEL_OUT:
; A variable to store the result, it can be:
; ${USER_PRIV_GUEST} (0) A guest account.
; ${USER_PRIV_USER} (1) A limited account.
; ${USER_PRIV_ADMIN} (2) An administrator account.
; error An error ocurred while calling.
ReadEnvStr $R0 UserName
${GetUserLevel} $0 $R0
MessageBox MB_OK "The user $R0's level is $0."
${GetUserLevel} $0 Administrator
MessageBox MB_OK "The user Administrator's level is $0."
</highlight-nsis>

== Function (by Afrow UK) ==
Based on [http://vcfaq.mvps.org/sdk/21.htm this code]
Note: After testing in the field, this function does not always work. Use the other function or use the included NSIS UserInfo plug-in (UserInfo::GetAccountType).<highlight-nsis>!define SC_MANAGER_LOCK 8
!define ERROR_SERVICE_DATABASE_LOCKED 1055

Function IsUserAdmin
Push $R0
Push $R1
Push $R2

StrCpy $R0 0

System::Call `advapi32::OpenSCManager(i 0, i 0, i ${SC_MANAGER_LOCK}) i.R1`
${If} $R1 != 0
System::Call `advapi32::LockServiceDatabase(i R1) i.R2`
${If} $R2 != 0
System::Call `advapi32::UnlockServiceDatabase(i R2)`
StrCpy $R0 1
${Else}
System::Call `kernel32::GetLastError() i.R2`
${If} $R2 == ${ERROR_SERVICE_DATABASE_LOCKED}
StrCpy $R0 1
${EndIf}
${EndIf}
System::Call `advapi32::CloseServiceHandle(i R1)`
${EndIf}

Pop $R2
Pop $R1
Exch $R0
FunctionEnd</highlight-nsis>
=== Usage ===
<highlight-nsis>Call IsUserAdmin
Pop $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Recursively remove empty parent directories

2013-07-26T08:51:25Z

550771955: /* Another function (by jiake) */

{{PageAuthor|ParallaxTZ}}

== Description ==

This function and example function call can be used to recursively delete empty parent folders of a given folder.

(Courtesy of the folks at [http://www.redbugtech.com Redbug Technologies] (www.redbugtech.com))

== The Script ==

<highlight-nsis>
Function un.RMDirUP
!define RMDirUP '!insertmacro RMDirUPCall'

!macro RMDirUPCall _PATH
push '${_PATH}'
Call un.RMDirUP
!macroend

; $0 - current folder
ClearErrors

Exch $0
;DetailPrint "ASDF - $0\.."
RMDir "$0\.."

IfErrors Skip
${RMDirUP} "$0\.."
Skip:

Pop $0
FunctionEnd
</highlight-nsis>

== Usage ==
The function declaration (as above) must appear before the call in the installation script.
<highlight-nsis>
RMDir /r "$INSTDIR" ;remove $INSTDIR and all files/subfolders
${RMDirUP} "$INSTDIR" ;remove $INSTDIR's parents (if each is empty ONLY)
</highlight-nsis>

== Another function (by jiake) ==

<highlight-nsis>
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
Push $R2
lbl_loop:
# Strip the last backslash
StrCpy $R1 $R0 "" -1
StrCmp $R1 "\" 0 +2
StrCpy $R0 $R0 -1
# Check if it is root path
StrCpy $R1 $R0 2
StrCmp $R1 $R0 lbl_end
# Check if it is empty
FindFirst $R1 $R2 "$R0\*.*"
lbl_dir:
StrCmp $R2 "." +2
StrCmp $R2 ".." 0 +3
FindNext $R1 $R2
Goto lbl_dir
FindClose $R1
# After skip "." & ".."
StrCmp $R2 "" 0 lbl_end
# No more files found, it is an empty folder
RMDir $R0
# Get the parent folder the loop
GetFullPathName $R0 "$R0\.."
Goto lbl_loop
lbl_end:
Pop $R2
Pop $R1
Pop $R0
FunctionEnd

/*
# Calling Windows API version
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
lbl_loop:
System::Call "shlwapi::PathAddBackslash(tR0R0)"
System::Call "shlwapi::PathIsRoot(tR0)i.R1"
StrCmp $R1 0 0 lbl_end
System::Call "shlwapi::PathIsDirectoryEmpty(tR0)i.R1"
StrCmp $R1 0 lbl_end
RMDir $R0
System::Call "shlwapi::PathAppend(tR0R0,ts)" ".."
Goto lbl_loop
lbl_end:
Pop $R1
Pop $R0
FunctionEnd
*/

Section -Test
# Create a temp direcotry
CreateDirectory "$TEMP\1\22\333\4444\55555"
# Recursive remove empty directories
Push "$TEMP\1\22\333\4444\55555"
Call RecursiveRemoveEmptyDirectory
SectionEnd
</highlight-nsis>

== Known issues ==
If a directory include more than one empty sub directories, this function fails.

[[Category:Disk, Path & File Functions]]

Recursively remove empty parent directories

2013-07-26T07:43:47Z

550771955: Windows API version added

{{PageAuthor|ParallaxTZ}}

== Description ==

This function and example function call can be used to recursively delete empty parent folders of a given folder.

(Courtesy of the folks at [http://www.redbugtech.com Redbug Technologies] (www.redbugtech.com))

== The Script ==

<highlight-nsis>
Function un.RMDirUP
!define RMDirUP '!insertmacro RMDirUPCall'

!macro RMDirUPCall _PATH
push '${_PATH}'
Call un.RMDirUP
!macroend

; $0 - current folder
ClearErrors

Exch $0
;DetailPrint "ASDF - $0\.."
RMDir "$0\.."

IfErrors Skip
${RMDirUP} "$0\.."
Skip:

Pop $0
FunctionEnd
</highlight-nsis>

== Usage ==
The function declaration (as above) must appear before the call in the installation script.
<highlight-nsis>
RMDir /r "$INSTDIR" ;remove $INSTDIR and all files/subfolders
${RMDirUP} "$INSTDIR" ;remove $INSTDIR's parents (if each is empty ONLY)
</highlight-nsis>

== Another function (by jiake) ==

<highlight-nsis>
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
Push $R2
lbl_loop:
# Strip the last backslash
StrCpy $R1 $R0 "" -1
StrCmp $R1 "\" 0 +2
StrCpy $R0 $R0 -1
# Check if it is root path
StrCpy $R1 $R0 2
StrCmp $R1 $R0 lbl_end
# Check if it is empty
FindFirst $R1 $R2 "$R0\*.*"
lbl_find:
StrCmp $R2 "." +2
StrCmp $R2 ".." 0 +3
FindNext $R1 $R2
Goto lbl_dir
FindClose $R1
# After skip "." & ".."
StrCmp $R2 "" 0 lbl_end
# No more files found, it is an empty folder
RMDir $R0
# Get the parent folder the loop
GetFullPathName $R0 "$R0\.."
Goto lbl_loop
lbl_end:
Pop $R2
Pop $R1
Pop $R0
FunctionEnd

/*
# Calling Windows API version
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
lbl_loop:
System::Call "shlwapi::PathAddBackslash(tR0R0)"
System::Call "shlwapi::PathIsRoot(tR0)i.R1"
StrCmp $R1 0 0 lbl_end
System::Call "shlwapi::PathIsDirectoryEmpty(tR0)i.R1"
StrCmp $R1 0 lbl_end
RMDir $R0
System::Call "shlwapi::PathAppend(tR0R0,ts)" ".."
Goto lbl_loop
lbl_end:
Pop $R1
Pop $R0
FunctionEnd
*/

Section -Test
# Create a temp direcotry
CreateDirectory "$TEMP\1\22\333\4444\55555"
# Recursive remove empty directories
Push "$TEMP\1\22\333\4444\55555"
Call RecursiveRemoveEmptyDirectory
SectionEnd
</highlight-nsis>

== Known issues ==
If a directory include more than one empty sub directories, this function fails.

[[Category:Disk, Path & File Functions]]

Recursively remove empty parent directories

2013-07-26T07:42:03Z

550771955: /* Another function (by jiake) */

{{PageAuthor|ParallaxTZ}}

== Description ==

This function and example function call can be used to recursively delete empty parent folders of a given folder.

(Courtesy of the folks at [http://www.redbugtech.com Redbug Technologies] (www.redbugtech.com))

== The Script ==

<highlight-nsis>
Function un.RMDirUP
!define RMDirUP '!insertmacro RMDirUPCall'

!macro RMDirUPCall _PATH
push '${_PATH}'
Call un.RMDirUP
!macroend

; $0 - current folder
ClearErrors

Exch $0
;DetailPrint "ASDF - $0\.."
RMDir "$0\.."

IfErrors Skip
${RMDirUP} "$0\.."
Skip:

Pop $0
FunctionEnd
</highlight-nsis>

== Usage ==
The function declaration (as above) must appear before the call in the installation script.
<highlight-nsis>
RMDir /r "$INSTDIR" ;remove $INSTDIR and all files/subfolders
${RMDirUP} "$INSTDIR" ;remove $INSTDIR's parents (if each is empty ONLY)
</highlight-nsis>

== Another function (by jiake) ==

<highlight-nsis>
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
Push $R2
lbl_loop:
# Strip the last backslash
StrCpy $R1 $R0 "" -1
StrCmp $R1 "\" 0 +2
StrCpy $R0 $R0 -1
# Check if it is root path
StrCpy $R1 $R0 2
StrCmp $R1 $R0 lbl_end
# Check if it is empty
FindFirst $R1 $R2 "$R0\*.*"
lbl_find:
StrCmp $R2 "." +2
StrCmp $R2 ".." 0 +3
FindNext $R1 $R2
Goto lbl_dir
FindClose $R1
# After skip "." & ".."
StrCmp $R2 "" 0 lbl_end
# No more files found, it is an empty folder
RMDir $R0
# Get the parent folder the loop
GetFullPathName $R0 "$R0\.."
Goto lbl_loop
lbl_end:
Pop $R2
Pop $R1
Pop $R0
FunctionEnd

/*
# Call Windows API version
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
lbl_loop:
System::Call "shlwapi::PathAddBackslash(tR0R0)"
System::Call "shlwapi::PathIsRoot(tR0)i.R1"
StrCmp $R1 0 0 lbl_end
System::Call "shlwapi::PathIsDirectoryEmpty(tR0)i.R1"
StrCmp $R1 0 lbl_end
RMDir $R0
System::Call "shlwapi::PathAppend(tR0R0,ts)" ".."
Goto lbl_loop
lbl_end:
Pop $R1
Pop $R0
FunctionEnd
*/

Section -Test
# Create a temp direcotry
CreateDirectory "$TEMP\1\22\333\4444\55555"
# Recursive remove empty directories
Push "$TEMP\1\22\333\4444\55555"
Call RecursiveRemoveEmptyDirectory
SectionEnd
</highlight-nsis>

== Known issues ==
If a directory include more than one empty sub directories, this function fails.

[[Category:Disk, Path & File Functions]]

Recursively remove empty parent directories

2013-07-26T07:38:49Z

550771955:

{{PageAuthor|ParallaxTZ}}

== Description ==

This function and example function call can be used to recursively delete empty parent folders of a given folder.

(Courtesy of the folks at [http://www.redbugtech.com Redbug Technologies] (www.redbugtech.com))

== The Script ==

<highlight-nsis>
Function un.RMDirUP
!define RMDirUP '!insertmacro RMDirUPCall'

!macro RMDirUPCall _PATH
push '${_PATH}'
Call un.RMDirUP
!macroend

; $0 - current folder
ClearErrors

Exch $0
;DetailPrint "ASDF - $0\.."
RMDir "$0\.."

IfErrors Skip
${RMDirUP} "$0\.."
Skip:

Pop $0
FunctionEnd
</highlight-nsis>

== Usage ==
The function declaration (as above) must appear before the call in the installation script.
<highlight-nsis>
RMDir /r "$INSTDIR" ;remove $INSTDIR and all files/subfolders
${RMDirUP} "$INSTDIR" ;remove $INSTDIR's parents (if each is empty ONLY)
</highlight-nsis>

== Another function (by jiake) ==

<highlight-nsis>
Function RecursiveRemoveEmptyDirectory
Exch $R0
Push $R1
Push $R2
lbl_loop:
# Strip the last backslash
StrCpy $R1 $R0 "" -1
StrCmp $R1 "\" 0 +2
StrCpy $R0 $R0 -1
# Check if it is root path
StrCpy $R1 $R0 2
StrCmp $R1 $R0 lbl_end
# Check if it is empty
FindFirst $R1 $R2 "$R0\*.*"
lbl_find:
StrCmp $R2 "." +2
StrCmp $R2 ".." 0 +3
FindNext $R1 $R2
Goto lbl_dir
FindClose $R1
# After skip "." & ".."
StrCmp $R2 "" 0 lbl_end
# No more files found, it is an empty folder
RMDir $R0
# Get the parent folder the loop
GetFullPathName $R0 "$R0\.."
Goto lbl_loop
lbl_end:
Pop $R2
Pop $R1
Pop $R0
FunctionEnd

Section -Test
# Create a temp direcotry
CreateDirectory "$TEMP\1\22\333\4444\55555"
# Recursive remove empty directories
Push "$TEMP\1\22\333\4444\55555"
Call RecursiveRemoveEmptyDirectory
SectionEnd
</highlight-nsis>

== Known issues ==
If a directory include more than one empty sub directories, this function fails.

[[Category:Disk, Path & File Functions]]

NsDialogs CreateIPaddress

2013-06-15T08:08:56Z

550771955: /* Example */

== Description ==
This header is an extension to the existing nsDialogs.nsh header file, and adds the ability to create IP address controls via a new ${NSD_CreateIPaddress} command. IP address controls look like a standard edit (text) control, but separated logically by 3 dots, where each of the 4 parts only accepts numbers within the range 0 .. 255. An IP address control is the logical choice when requiting IP address input.
ofer

== Attribution ==
This header is the result of the forum discussion [http://forums.winamp.com/showthread.php?threadid=302172 nsDialogs IP Address Control], and credit goes largely to Xokar and Anders for the correct system calls and to the nsDialogs header team for the conventions laid out therein.

A fix for a font corruption bug stems from the forum discussion [http://forums.winamp.com/showthread.php?t=318497 Problem of NSD_CreateIPAddress.nsh ]

== Header ==
* Main download link: <attach>Nsdialogs_createIpaddress.zip</attach>.
 MD5: 23e8d124fadf7f9af7ea865fe495675a | Filesize: 1023B 

== Creating ==
Although typically the various internet controls may already be initialized on your system, it is a good idea to make sure they are indeed initialized. For the IPaddress control, use ${NSD_InitIPaddress} to initialize the control. If used, this should only be needed once (e.g. in .onGuiInit).

Creating the IPaddress control is as simple as creating any other control, using '${NSD_CreateIPaddress} top left width height ""'. Note that the IP address control does not take any label text and is thus left blank.

== Writing ==
You can set the IP address using the existing '${NSD_SetText}' function. For example: '${NSD_SetText} <control> "192.168.0.0"'. The accepted text must be a valid IP address of format #.#.#.# .

== Callbacks ==
The IPaddress control only triggers the '${NSD_OnNotify}' callback. This callback is triggered in two cases:
* twice after one part of an IP address is entered (once for the entered text, once again for the next part receiving focus). To separate the two events, set a temporary variable.
* once after the IP address control loses focus (user tabs out, clicks out, etc.)

If you want to do some type of validation on the IP address entered once the control loses focus you will have to get the focus of the current control and compare that to the four hwnds of each of the IP address fields.

You can get each of the fields using:
<highlight-nsis>
FindWindow $Field4 "" "" $IPAddressControl
FindWindow $Field3 "" "" $IPAddressControl $Field4
FindWindow $Field2 "" "" $IPAddressControl $Field3
FindWindow $Field1 "" "" $IPAddressControl $Field2
</highlight-nsis>

You can get the hwnd of the control that currently has focus using:
<highlight-nsis>
System::Call "user32::GetFocus(v) i.r0" ; $0 now contains the hwnd
</highlight-nsis>

Using this information you can check if, after a notification, one of the 4 IP address fields has focus, or whether focus was lost from all the IP address fields; using LogicLib:
<highlight-nsis>
${Select} $0
${Case} $Field1
${Case} $Field2
${Case} $Field3
${Case} $Field4
${Default}
; process here
${EndSelect}
</highlight-nsis>

== Reading ==
To read the IP address entered, you can use the existing '${NSD_GetText} <control> <outvar>' convention. The IP address is returned as a single string of format #.#.#.# . If you need to check pieces of the IP address, you will have to manually separate it into the appropriate pieces using existing string manipulation functions.

== Example ==
<highlight-nsis>
outfile 'nsdialogs_createIPaddress.exe'

!include 'nsdialogs.nsh'
!include 'nsdialogs_createIPaddress.nsh'

Page Custom CustomPre

Function CustomPre
nsDialogs::Create 1018
Pop $R0

${If} $R0 == error
Abort
${EndIf}

; This would more appropriately be called in .onGUIInit
${NSD_InitIPaddress}
Pop $0
IntCmp $0 0 0 +3 +3
MessageBox MB_OK "Something went wrong while initializing the IPaddress control"
Abort

${NSD_CreateIPaddress} 5% 90% 30% 12u ""
Pop $0

nsDialogs::Show
FunctionEnd

Section
SectionEnd
</highlight-nsis>

== Styling ==
Note that due to the nature of the control, you can only apply limited styling. For example, changing the background color of the control will result in an incorrectly painted control, while attempts to change the background color of any of the 4 fields will result in a crash.

[[Category:Headers]] [[Category:Code Examples]] [[Category:nsDialogs Examples]]

File:ThreadTimer v1.1.1.7z

2012-07-13T17:54:49Z

550771955: uploaded a new version of "File:ThreadTimer v1.1.1.7z"

ThreadTimer plug-in

2012-07-13T17:45:06Z

550771955:

== Download Link ==
v1.1.1 (updated 14th, July 2012) by [[User:550771955|jiake]] <attach>ThreadTimer_v1.1.1.7z</attach>, with tlibc static library.

v1.1 (updated October 2011) by [[User:Slappy|Slappy]] <attach>ThreadTimer.zip</attach> [http://forums.winamp.com/showthread.php?t=331275 Forum thread]

== Description ==
ThreadTimer plug-in allows you to create simple Timer which runs in a '''separate thread'''.
It is available since Start until Stop, it ticks in desired interval and calls NSIS function.
It can be created for a whole life-cycle of installer because it is NOT tied with any installer page or nsDialogs page.

I am using this plugin for creating cool-looking Graphical Installers: [http://www.unsigned-softworks.sk/installer www.unsigned-softworks.sk/installer] (see image below)

[[File:SkinnedControls-Example.jpg]]

== How To Use ==

See simple example below for fast start.

=== ThreadTimer::Start Function ===

Initializes Timer and starts it immediately.
NSIS Function will be called first time Interval milliseconds after calling Start.

==== Parameters ====

/NOUNLOAD
:This must be defined! Plug-in will crash without this parameter! Note: version 1.1.1 do not need.

Interval
:Interval for timer [milliseconds]. Timer ticks each Interval and calls NSIS Function.

Ticks
:Number of ticks for Timer. 0 or -1 for infinite loop. (v1.1.1, any value that less than or equal to 0 meant infinite loop).

NSIS Function
:Address of NSIS function to call from plug-in. Use GetFunctionAddress to obtain this address of your function.

=== ThreadTimer::Stop Function ===

Stops the timer immediately.

== Example ==
<highlight-nsis>
Function TryMe
MessageBox MB_OK "TryMe"
FunctionEnd

Function TimerExample
GetFunctionAddress $2 TryMe
; Note: version 1.1.1 do not need /NOUNLOAD switch.
ThreadTimer::Start /NOUNLOAD 2345 8 $2 ; Timer ticks every 2345 milliseconds, totally 8 times calls TryMe
FunctionEnd

Function TimerExampleInfiniteLoop
GetFunctionAddress $2 TryMe
; Note: version 1.1.1 do not need /NOUNLOAD switch.
ThreadTimer::Start /NOUNLOAD 1234 -1 $2 ; Timer ticks every 1234 milliseconds, it calls function TryMe in infinite loop until ThreadTimer::Stop is called
FunctionEnd

Function .onGUIEnd
ThreadTimer::Stop
FunctionEnd
</highlight-nsis>

== Notes ==
There are several important facts to know about this plug-in:
* Timer runs in separate thread. If you forget to call ThreadTimer::Stop it will still run however your NSIS installer exists! This may cause (and often causes) crash!
* There is no error handling in this version, be careful with parameters!
* If you need to execute some function periodically in whole life of installer (on each page, also while installing files, ...) use ThreadTimer::Start in your .onInit function.
* It is nice habit to call ThreadTimer::Stop in your .onGUIEnd function.
* Plug-in does not use SetTimer and KillTimer WinAPI functions. Instead it creates a new thread and uses Sleep() to wait for desired Interval. There might be a little inaccuracy in time periods!

== Versions History ==
;1.1.1 (July 2012)(by jiake)
* Update it so that you can remove /NOUNLOAD switch when using in NSIS
* Remove unused code from source
* Size 3.5kB(ANSI)/3kB(Unicode)

;1.1 (October 2011)
* Second version
* Unicode & ANSI builds are available
* Sources included
* Pure C code - removed all dependencies on CRT but included TinyC lib
* Removed decorated names of calls
* Size ~4kB

;1.0 (2011)
* First version
* Unicode & ANSI builds are available
* Sources included
* Removed dependency on MS VCR 9.0 runtime (Bigger size of dll).

== Credits ==
*Version 1.0 by [[User:Slappy|Slappy]] Graphical installers: [http://www.unsigned-softworks.sk www.unsigned-softworks.sk]
[[Category:Plugins]]

ThreadTimer plug-in

2012-07-13T17:37:18Z

550771955:

== Download Link ==
v1.1.1 (updated 14th, July 2012) by [[User:550771955|jiake]] <attach>ThreadTimer_v1.1.1.zip</attach>()

v1.1 (updated October 2011) by [[User:Slappy|Slappy]] <attach>ThreadTimer.zip</attach> [http://forums.winamp.com/showthread.php?t=331275 Forum thread]

== Description ==
ThreadTimer plug-in allows you to create simple Timer which runs in a '''separate thread'''.
It is available since Start until Stop, it ticks in desired interval and calls NSIS function.
It can be created for a whole life-cycle of installer because it is NOT tied with any installer page or nsDialogs page.

I am using this plugin for creating cool-looking Graphical Installers: [http://www.unsigned-softworks.sk/installer www.unsigned-softworks.sk/installer] (see image below)

[[File:SkinnedControls-Example.jpg]]

== How To Use ==

See simple example below for fast start.

=== ThreadTimer::Start Function ===

Initializes Timer and starts it immediately.
NSIS Function will be called first time Interval milliseconds after calling Start.

==== Parameters ====

/NOUNLOAD
:This must be defined! Plug-in will crash without this parameter! Note: version 1.1.1 do not need.

Interval
:Interval for timer [milliseconds]. Timer ticks each Interval and calls NSIS Function.

Ticks
:Number of ticks for Timer. 0 or -1 for infinite loop.

NSIS Function
:Address of NSIS function to call from plug-in. Use GetFunctionAddress to obtain this address of your function.

=== ThreadTimer::Stop Function ===

Stops the timer immediately.

== Example ==
<highlight-nsis>
Function TryMe
MessageBox MB_OK "TryMe"
FunctionEnd

Function TimerExample
GetFunctionAddress $2 TryMe
; Note: version 1.1.1 do not need /NOUNLOAD switch.
ThreadTimer::Start /NOUNLOAD 2345 8 $2 ; Timer ticks every 2345 milliseconds, totally 8 times calls TryMe
FunctionEnd

Function TimerExampleInfiniteLoop
GetFunctionAddress $2 TryMe
; Note: version 1.1.1 do not need /NOUNLOAD switch.
ThreadTimer::Start /NOUNLOAD 1234 -1 $2 ; Timer ticks every 1234 milliseconds, it calls function TryMe in infinite loop until ThreadTimer::Stop is called
FunctionEnd

Function .onGUIEnd
ThreadTimer::Stop
FunctionEnd
</highlight-nsis>

== Notes ==
There are several important facts to know about this plug-in:
* Timer runs in separate thread. If you forget to call ThreadTimer::Stop it will still run however your NSIS installer exists! This may cause (and often causes) crash!
* There is no error handling in this version, be careful with parameters!
* If you need to execute some function periodically in whole life of installer (on each page, also while installing files, ...) use ThreadTimer::Start in your .onInit function.
* It is nice habit to call ThreadTimer::Stop in your .onGUIEnd function.
* Plug-in does not use SetTimer and KillTimer WinAPI functions. Instead it creates a new thread and uses Sleep() to wait for desired Interval. There might be a little inaccuracy in time periods!

== Versions History ==
;1.1.1 (July 2012)(by jiake)
* Update it so that you can remove /NOUNLOAD switch when using in NSIS
* Remove unused code from source
* Size 3.5kB(ANSI)/3kB(Unicode)

;1.1 (October 2011)
* Second version
* Unicode & ANSI builds are available
* Sources included
* Pure C code - removed all dependencies on CRT but included TinyC lib
* Removed decorated names of calls
* Size ~4kB

;1.0 (2011)
* First version
* Unicode & ANSI builds are available
* Sources included
* Removed dependency on MS VCR 9.0 runtime (Bigger size of dll).

== Credits ==
*Version 1.0 by [[User:Slappy|Slappy]] Graphical installers: [http://www.unsigned-softworks.sk www.unsigned-softworks.sk]
[[Category:Plugins]]

File:ThreadTimer v1.1.1.7z

2012-07-13T17:35:07Z

550771955:

ThreadTimer plug-in

2012-07-13T17:28:56Z

550771955: /* Download Link */

== Download Link ==
v1.1.1 (updated 14th, July 2012) by [[User:550771955|jiake]] <attach>ThreadTimer_v1.1.1.zip</attach>

v1.1 (updated October 2011) by [[User:Slappy|Slappy]] <attach>ThreadTimer.zip</attach> [http://forums.winamp.com/showthread.php?t=331275 Forum thread]

== Description ==
ThreadTimer plug-in allows you to create simple Timer which runs in a '''separate thread'''.
It is available since Start until Stop, it ticks in desired interval and calls NSIS function.
It can be created for a whole life-cycle of installer because it is NOT tied with any installer page or nsDialogs page.

I am using this plugin for creating cool-looking Graphical Installers: [http://www.unsigned-softworks.sk/installer www.unsigned-softworks.sk/installer] (see image below)

[[File:SkinnedControls-Example.jpg]]

== How To Use ==

See simple example below for fast start.

=== ThreadTimer::Start Function ===

Initializes Timer and starts it immediately.
NSIS Function will be called first time Interval milliseconds after calling Start.

==== Parameters ====

/NOUNLOAD
: This must be defined! Plug-in will crash without this parameter!

Interval
:Interval for timer [milliseconds]. Timer ticks each Interval and calls NSIS Function.

Ticks
:Number of ticks for Timer. 0 or -1 for infinite loop.

NSIS Function
:Address of NSIS function to call from plug-in. Use GetFunctionAddress to obtain this address of your function.

=== ThreadTimer::Stop Function ===

Stops the timer immediately.

== Example ==
<highlight-nsis>
Function TryMe
MessageBox MB_OK "TryMe"
FunctionEnd

Function TimerExample
GetFunctionAddress $2 TryMe
ThreadTimer::Start /NOUNLOAD 2345 8 $2 ; Timer ticks every 2345 milliseconds, totally 8 times calls TryMe
FunctionEnd

Function TimerExampleInfiniteLoop
GetFunctionAddress $2 TryMe
ThreadTimer::Start /NOUNLOAD 1234 -1 $2 ; Timer ticks every 1234 milliseconds, it calls function TryMe in infinite loop until ThreadTimer::Stop is called
FunctionEnd

Function .onGUIEnd
ThreadTimer::Stop
FunctionEnd
</highlight-nsis>

== Notes ==
There are several important facts to know about this plug-in:
* Timer runs in separate thread. If you forget to call ThreadTimer::Stop it will still run however your NSIS installer exists! This may cause (and often causes) crash!
* There is no error handling in this version, be careful with parameters!
* If you need to execute some function periodically in whole life of installer (on each page, also while installing files, ...) use ThreadTimer::Start in your .onInit function.
* It is nice habit to call ThreadTimer::Stop in your .onGUIEnd function.
* Plug-in does not use SetTimer and KillTimer WinAPI functions. Instead it creates a new thread and uses Sleep() to wait for desired Interval. There might be a little inaccuracy in time periods!

== Versions History ==
;1.1.1 (July 2012)(by jiake)
* Update it so that you can remove /NOUNLOAD switch when using in NSIS
* Remove unused code from source
* Size 3.5kB(ANSI)/3kB(Unicode)

;1.1 (October 2011)
* Second version
* Unicode & ANSI builds are available
* Sources included
* Pure C code - removed all dependencies on CRT but included TinyC lib
* Removed decorated names of calls
* Size ~4kB

;1.0 (2011)
* First version
* Unicode & ANSI builds are available
* Sources included
* Removed dependency on MS VCR 9.0 runtime (Bigger size of dll).

== Credits ==
*Version 1.0 by [[User:Slappy|Slappy]] Graphical installers: [http://www.unsigned-softworks.sk www.unsigned-softworks.sk]
[[Category:Plugins]]

ThreadTimer plug-in

2012-07-13T17:28:23Z

550771955: /* Versions History */

== Download Link ==
v1.1 (updated October 2011) by [[User:Slappy|Slappy]] <attach>ThreadTimer.zip</attach> [http://forums.winamp.com/showthread.php?t=331275 Forum thread]

== Description ==
ThreadTimer plug-in allows you to create simple Timer which runs in a '''separate thread'''.
It is available since Start until Stop, it ticks in desired interval and calls NSIS function.
It can be created for a whole life-cycle of installer because it is NOT tied with any installer page or nsDialogs page.

I am using this plugin for creating cool-looking Graphical Installers: [http://www.unsigned-softworks.sk/installer www.unsigned-softworks.sk/installer] (see image below)

[[File:SkinnedControls-Example.jpg]]

== How To Use ==

See simple example below for fast start.

=== ThreadTimer::Start Function ===

Initializes Timer and starts it immediately.
NSIS Function will be called first time Interval milliseconds after calling Start.

==== Parameters ====

/NOUNLOAD
: This must be defined! Plug-in will crash without this parameter!

Interval
:Interval for timer [milliseconds]. Timer ticks each Interval and calls NSIS Function.

Ticks
:Number of ticks for Timer. 0 or -1 for infinite loop.

NSIS Function
:Address of NSIS function to call from plug-in. Use GetFunctionAddress to obtain this address of your function.

=== ThreadTimer::Stop Function ===

Stops the timer immediately.

== Example ==
<highlight-nsis>
Function TryMe
MessageBox MB_OK "TryMe"
FunctionEnd

Function TimerExample
GetFunctionAddress $2 TryMe
ThreadTimer::Start /NOUNLOAD 2345 8 $2 ; Timer ticks every 2345 milliseconds, totally 8 times calls TryMe
FunctionEnd

Function TimerExampleInfiniteLoop
GetFunctionAddress $2 TryMe
ThreadTimer::Start /NOUNLOAD 1234 -1 $2 ; Timer ticks every 1234 milliseconds, it calls function TryMe in infinite loop until ThreadTimer::Stop is called
FunctionEnd

Function .onGUIEnd
ThreadTimer::Stop
FunctionEnd
</highlight-nsis>

== Notes ==
There are several important facts to know about this plug-in:
* Timer runs in separate thread. If you forget to call ThreadTimer::Stop it will still run however your NSIS installer exists! This may cause (and often causes) crash!
* There is no error handling in this version, be careful with parameters!
* If you need to execute some function periodically in whole life of installer (on each page, also while installing files, ...) use ThreadTimer::Start in your .onInit function.
* It is nice habit to call ThreadTimer::Stop in your .onGUIEnd function.
* Plug-in does not use SetTimer and KillTimer WinAPI functions. Instead it creates a new thread and uses Sleep() to wait for desired Interval. There might be a little inaccuracy in time periods!

== Versions History ==
;1.1.1 (July 2012)(by jiake)
* Update it so that you can remove /NOUNLOAD switch when using in NSIS
* Remove unused code from source
* Size 3.5kB(ANSI)/3kB(Unicode)

;1.1 (October 2011)
* Second version
* Unicode & ANSI builds are available
* Sources included
* Pure C code - removed all dependencies on CRT but included TinyC lib
* Removed decorated names of calls
* Size ~4kB

;1.0 (2011)
* First version
* Unicode & ANSI builds are available
* Sources included
* Removed dependency on MS VCR 9.0 runtime (Bigger size of dll).

== Credits ==
*Version 1.0 by [[User:Slappy|Slappy]] Graphical installers: [http://www.unsigned-softworks.sk www.unsigned-softworks.sk]
[[Category:Plugins]]

ThreadTimer plug-in

2012-07-13T17:27:24Z

550771955: /* Versions History */

Check if the current user is an Administrator

2012-07-12T16:56:11Z

550771955: /* Macro 3 (Windows 2k or above) */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

There are 3 alternative implementations (2 macros and 1 function).

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

=== Macro 3 (Windows 2k or above) ===
Today an NSIS user in our QQ group ask for this question again: how to determine whether the current user is an administrator user. I found that a Windows API can get the information of the specified user name, it's more easier than the above ways, I write it and so add it here. Any question please email jiake(at)vip.qq.com.
<highlight-nsis>
!define USER_PRIV_GUEST 0
!define USER_PRIV_USER 1
!define USER_PRIV_ADMIN 2

!include "Util.nsh"
!define GetUserLevel "!insertmacro Call_GetUserLevel"
!macro Call_GetUserLevel _level _username
!verbose push
!verbose 3
Push ${_username}
${CallArtificialFunction} Func_GetUserLevel
Pop ${_level}
!verbose pop
!macroend
!macro Func_GetUserLevel
Exch $R0
Push $R1
System::Call "*(i)i.R1"
System::Call "netapi32::NetUserGetInfo(in,wR0,i1,iR1)i.R0"
IntCmp $R0 0 +3
Push error
Goto lbl_end
System::Call "*$R1(i.R0)"
System::Call "*$R0(w,w,i,i.s)"
System::Call "netapi32::NetApiBufferFree(iR0)"
lbl_end:
System::Free $R1
Exch
Pop $R1
Exch
Pop $R0
!macroend
</highlight-nsis>
Usage example:
<highlight-nsis>
; ${GetUserLevel} VAR_USER_LEVEL_OUT STRING_OR_VAR_USERNAME
; STRING_OR_VAR_USERNAME:
; A valid username.
; VAR_USER_LEVEL_OUT:
; A variable to store the result, it can be:
; ${USER_PRIV_GUEST} (0) A guest account.
; ${USER_PRIV_USER} (1) A limited account.
; ${USER_PRIV_ADMIN} (2) An administrator account.
; error An error ocurred while calling.
ReadEnvStr $R0 UserName
${GetUserLevel} $0 $R0
MessageBox MB_OK "The user $R0's level is $0."
${GetUserLevel} $0 Administrator
MessageBox MB_OK "The user Administrator's level is $0."
</highlight-nsis>

== Function (by Afrow UK) ==
Based on [http://vcfaq.mvps.org/sdk/21.htm this code]
Note: After testing in the field, this function does not always work. Use the other function or use the included NSIS UserInfo plug-in (UserInfo::GetAccountType).<highlight-nsis>!define SC_MANAGER_LOCK 8
!define ERROR_SERVICE_DATABASE_LOCKED 1055

Function IsUserAdmin
Push $R0
Push $R1
Push $R2

StrCpy $R0 0

System::Call `advapi32::OpenSCManager(i 0, i 0, i ${SC_MANAGER_LOCK}) i.R1`
${If} $R1 != 0
System::Call `advapi32::LockServiceDatabase(i R1) i.R2`
${If} $R2 != 0
System::Call `advapi32::UnlockServiceDatabase(i R2)`
StrCpy $R0 1
${Else}
System::Call `kernel32::GetLastError() i.R2`
${If} $R2 == ${ERROR_SERVICE_DATABASE_LOCKED}
StrCpy $R0 1
${EndIf}
${EndIf}
System::Call `advapi32::CloseServiceHandle(i R1)`
${EndIf}

Pop $R2
Pop $R1
Exch $R0
FunctionEnd</highlight-nsis>
=== Usage ===
<highlight-nsis>Call IsUserAdmin
Pop $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Check if the current user is an Administrator

2012-06-30T10:17:50Z

550771955: /* Macro 3 (Windows 2k or above) */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

There are 3 alternative implementations (2 macros and 1 function).

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

=== Macro 3 (Windows 2k or above) ===
Today an NSIS user in our QQ group ask for this question again: how to determine whether the current user is an administrator user. I found that a Windows API can get the information of the specified user name, it's more easier than the above ways, I write it and so add it here. Any question please email jiake(at)vip.qq.com.
<highlight-nsis>
!define USER_PRIV_GUEST 0
!define USER_PRIV_USER 1
!define USER_PRIV_ADMIN 2

!include "Util.nsh"
!define GetUserLevel "!insertmacro Call_GetUserLevel"
!macro Call_GetUserLevel _level _username
!verbose push
!verbose 3
Push ${_username}
${CallArtificialFunction} Func_GetUserLevel
Pop ${_level}
!verbose pop
!macroend
!macro Func_GetUserLevel
Exch $R0
Push $R1
System::Call "*(i)i.R1"
System::Call "netapi32::NetUserGetInfo(in,wR0,i1,iR1)i.R0"
IntCmp $R0 0 +3
Push error
Goto lbl_end
System::Call "*$R1(i.R0)"
System::Call "*$R0(w,w,i,i.s)"
System::Call "netapi32::NetApiBufferFree(iR0)"
lbl_end:
System::Free $R1
Exch
Pop $R1
Exch
Pop $R0
!macroend
</highlight-nsis>
Usage example:
<highlight-nsis>
; ${GetUserLevel} VAR_USER_LEVEL_OUT STRING_OR_VAR_USERNAME
; STRING_OR_VAR_USERNAME:
; A valid username.
; VAR_USER_LEVEL_OUT:
; A varible to store the result, it can be:
; ${USER_PRIV_GUEST} (0) A guest account.
; ${USER_PRIV_USER} (1) A limited account.
; ${USER_PRIV_ADMIN} (2) An administrator account.
; error An error ocurred while calling.
ReadEnvStr $R0 UserName
${GetUserLevel} $0 $R0
MessageBox MB_OK "The user $R0's level is $0."
${GetUserLevel} $0 Administrator
MessageBox MB_OK "The user Administrator's level is $0."
</highlight-nsis>

== Function (by Afrow UK) ==
Based on [http://vcfaq.mvps.org/sdk/21.htm this code]
Note: After testing in the field, this function does not always work. Use the other function or use the included NSIS UserInfo plug-in (UserInfo::GetAccountType).<highlight-nsis>!define SC_MANAGER_LOCK 8
!define ERROR_SERVICE_DATABASE_LOCKED 1055

Function IsUserAdmin
Push $R0
Push $R1
Push $R2

StrCpy $R0 0

System::Call `advapi32::OpenSCManager(i 0, i 0, i ${SC_MANAGER_LOCK}) i.R1`
${If} $R1 != 0
System::Call `advapi32::LockServiceDatabase(i R1) i.R2`
${If} $R2 != 0
System::Call `advapi32::UnlockServiceDatabase(i R2)`
StrCpy $R0 1
${Else}
System::Call `kernel32::GetLastError() i.R2`
${If} $R2 == ${ERROR_SERVICE_DATABASE_LOCKED}
StrCpy $R0 1
${EndIf}
${EndIf}
System::Call `advapi32::CloseServiceHandle(i R1)`
${EndIf}

Pop $R2
Pop $R1
Exch $R0
FunctionEnd</highlight-nsis>
=== Usage ===
<highlight-nsis>Call IsUserAdmin
Pop $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Check if the current user is an Administrator

2012-06-25T05:23:26Z

550771955: /* Macro 3 (Windows 2k or above, by jiake) */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

There are 3 alternative implementations (2 macros and 1 function).

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

=== Macro 3 (Windows 2k or above) ===
Today an NSIS user in our QQ group ask for this question again: how to determine whether the current user is an administrator user. I found that a Windows API can get the information of the specified user name, it's more easier than the above ways, I write it and so add it here. Any question please email jiake(at)vip.qq.com.
<highlight-nsis>
!define USER_PRIV_GUEST 0
!define USER_PRIV_USER 1
!define USER_PRIV_ADMIN 2

!include "Util.nsh"
!define GetUserLevel "!insertmacro Call_GetUserLevel"
!macro Call_GetUserLevel _level _username
!verbose push
!verbose 3
Push ${_username}
${CallArtificialFunction} Func_GetUserLevel
Pop ${_level}
!verbose pop
!macroend
!macro Func_GetUserLevel
Exch $R0
Push $R1
System::Call "*(i)i.R1"
System::Call "netapi32::NetUserGetInfo(in,wR0,i1,iR1)i.R0"
IntCmp $R0 0 +3
Push error
Goto lbl_end
System::Call "*$R1(i.R0)"
System::Call "*$R0(w,w,i,i.s)"
System::Call "netapi32::NetApiBufferFree(iR0)"
lbl_end:
System::Free $R1
Exch
Pop $R1
Exch
Pop $R0
!macroend
</highlight-nsis>
Usage example:
<highlight-nsis>
; ${GetUserLevel} VAR_USER_LEVEL_OUT STRING_OR_VAR_USERNAME
; STRING_OR_VAR_USERNAME:
; A valid username.
; VAR_USER_LEVEL_OUT:
; A varible to store the result, it can be:
; ${USER_PRIV_GUEST} (0) A guest account.
; ${USER_PRIV_USER} (1) A limited account.
; ${USER_PRIV_ADMIN} (2) An administrator account.
; error A error ocurred while calling.
ReadEnvStr $R0 UserName
${GetUserLevel} $0 $R0
MessageBox MB_OK "The user $R0's level is $0."
${GetUserLevel} $0 Administrator
MessageBox MB_OK "The user Administrator's level is $0."
</highlight-nsis>

== Function (by Afrow UK) ==
Based on [http://vcfaq.mvps.org/sdk/21.htm this code]
Note: After testing in the field, this function does not always work. Use the other function or use the included NSIS UserInfo plug-in (UserInfo::GetAccountType).<highlight-nsis>!define SC_MANAGER_LOCK 8
!define ERROR_SERVICE_DATABASE_LOCKED 1055

Function IsUserAdmin
Push $R0
Push $R1
Push $R2

StrCpy $R0 0

System::Call `advapi32::OpenSCManager(i 0, i 0, i ${SC_MANAGER_LOCK}) i.R1`
${If} $R1 != 0
System::Call `advapi32::LockServiceDatabase(i R1) i.R2`
${If} $R2 != 0
System::Call `advapi32::UnlockServiceDatabase(i R2)`
StrCpy $R0 1
${Else}
System::Call `kernel32::GetLastError() i.R2`
${If} $R2 == ${ERROR_SERVICE_DATABASE_LOCKED}
StrCpy $R0 1
${EndIf}
${EndIf}
System::Call `advapi32::CloseServiceHandle(i R1)`
${EndIf}

Pop $R2
Pop $R1
Exch $R0
FunctionEnd</highlight-nsis>
=== Usage ===
<highlight-nsis>Call IsUserAdmin
Pop $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Check if the current user is an Administrator

2012-06-25T05:21:26Z

550771955: /* Macro 3 (Windows 2k or above, by jiake) */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

There are 3 alternative implementations (2 macros and 1 function).

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

=== Macro 3 (Windows 2k or above, by jiake) ===
Today an NSIS user in our QQ group ask for this question again: how to determine whether the current user is an administrator user. I found that a Windows API can get the information of the specified user name, it's more easier than the above ways, I write it and so add it here.
<highlight-nsis>
!define USER_PRIV_GUEST 0
!define USER_PRIV_USER 1
!define USER_PRIV_ADMIN 2

!include "Util.nsh"
!define GetUserLevel "!insertmacro Call_GetUserLevel"
!macro Call_GetUserLevel _level _username
!verbose push
!verbose 3
Push ${_username}
${CallArtificialFunction} Func_GetUserLevel
Pop ${_level}
!verbose pop
!macroend
!macro Func_GetUserLevel
Exch $R0
Push $R1
System::Call "*(i)i.R1"
System::Call "netapi32::NetUserGetInfo(in,wR0,i1,iR1)i.R0"
IntCmp $R0 0 +3
Push error
Goto lbl_end
System::Call "*$R1(i.R0)"
System::Call "*$R0(w,w,i,i.s)"
System::Call "netapi32::NetApiBufferFree(iR0)"
lbl_end:
System::Free $R1
Exch
Pop $R1
Exch
Pop $R0
!macroend
</highlight-nsis>
Usage example:
<highlight-nsis>
; ${GetUserLevel} VAR_USER_LEVEL_OUT STRING_OR_VAR_USERNAME
; STRING_OR_VAR_USERNAME:
; A valid username.
; VAR_USER_LEVEL_OUT:
; A varible to store the result, it can be:
; ${USER_PRIV_GUEST} (0) A guest account.
; ${USER_PRIV_USER} (1) A limited account.
; ${USER_PRIV_ADMIN} (2) An administrator account.
; error A error ocurred while calling.
ReadEnvStr $R0 UserName
${GetUserLevel} $0 $R0
MessageBox MB_OK "The user $R0's level is $0."
${GetUserLevel} $0 Administrator
MessageBox MB_OK "The user Administrator's level is $0."
</highlight-nsis>

== Function (by Afrow UK) ==
Based on [http://vcfaq.mvps.org/sdk/21.htm this code]
Note: After testing in the field, this function does not always work. Use the other function or use the included NSIS UserInfo plug-in (UserInfo::GetAccountType).<highlight-nsis>!define SC_MANAGER_LOCK 8
!define ERROR_SERVICE_DATABASE_LOCKED 1055

Function IsUserAdmin
Push $R0
Push $R1
Push $R2

StrCpy $R0 0

System::Call `advapi32::OpenSCManager(i 0, i 0, i ${SC_MANAGER_LOCK}) i.R1`
${If} $R1 != 0
System::Call `advapi32::LockServiceDatabase(i R1) i.R2`
${If} $R2 != 0
System::Call `advapi32::UnlockServiceDatabase(i R2)`
StrCpy $R0 1
${Else}
System::Call `kernel32::GetLastError() i.R2`
${If} $R2 == ${ERROR_SERVICE_DATABASE_LOCKED}
StrCpy $R0 1
${EndIf}
${EndIf}
System::Call `advapi32::CloseServiceHandle(i R1)`
${EndIf}

Pop $R2
Pop $R1
Exch $R0
FunctionEnd</highlight-nsis>
=== Usage ===
<highlight-nsis>Call IsUserAdmin
Pop $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Check if the current user is an Administrator

2012-06-25T05:17:54Z

550771955: /* Macro 3 (Windows 2k or above, by jiake) */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

There are 3 alternative implementations (2 macros and 1 function).

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

=== Macro 3 (Windows 2k or above, by jiake) ===
Today an NSIS user in our QQ group ask for this question again: how to determine whether the current user is an administrator user. I found that a Windows API can get the information of the specified user name, it's more easier than the above ways, I write it and so add it here.
<highlight-nsis>
!define USER_PRIV_GUEST 0
!define USER_PRIV_USER 1
!define USER_PRIV_ADMIN 2

!include "Util.nsh"
!define GetUserLevel "!insertmacro Call_GetUserLevel"
!macro Call_GetUserLevel _level _username
!verbose push
!verbose 3
Push ${_username}
${CallArtificialFunction} Func_GetUserLevel
Pop ${_level}
!verbose pop
!macroend
!macro Func_GetUserLevel
Exch $R0
Push $R1
System::Call "*(i)i.R1"
System::Call "netapi32::NetUserGetInfo(in,wR0,i1,iR1)i.R0"
IntCmp $R0 0 +3
Push error
Goto lbl_end
System::Call "*$R1(i.R0)"
System::Call "*$R0(w,w,i,i.s)"
System::Call "netapi32::NetApiBufferFree(iR0)"
lbl_end:
System::Free $R1
Exch
Pop $R1
Exch
Pop $R0
!macroend
</highlight-nsis>
Usage example:
<highlight-nsis>
; ${GetUserLevel} VAR_USER_LEVEL_OUT STRING_OR_VAR_USERNAME
; STRING_OR_VAR_USERNAME:
; A valid username.
; VAR_USER_LEVEL_OUT:
; A varible to store the result, it can be:
; ${USER_PRIV_GUEST} A guest account.
; ${USER_PRIV_USER} A Limited account.
; ${USER_PRIV_ADMIN} An administrator account.
; error A error ocurred while calling.
ReadEnvStr $R0 UserName
${GetUserLevel} $0 $R0
MessageBox MB_OK "The user $R0's level is $0."
${GetUserLevel} $0 Administrator
MessageBox MB_OK "The user Administrator's level is $0."
</highlight-nsis>

== Function (by Afrow UK) ==
Based on [http://vcfaq.mvps.org/sdk/21.htm this code]
Note: After testing in the field, this function does not always work. Use the other function or use the included NSIS UserInfo plug-in (UserInfo::GetAccountType).<highlight-nsis>!define SC_MANAGER_LOCK 8
!define ERROR_SERVICE_DATABASE_LOCKED 1055

Function IsUserAdmin
Push $R0
Push $R1
Push $R2

StrCpy $R0 0

System::Call `advapi32::OpenSCManager(i 0, i 0, i ${SC_MANAGER_LOCK}) i.R1`
${If} $R1 != 0
System::Call `advapi32::LockServiceDatabase(i R1) i.R2`
${If} $R2 != 0
System::Call `advapi32::UnlockServiceDatabase(i R2)`
StrCpy $R0 1
${Else}
System::Call `kernel32::GetLastError() i.R2`
${If} $R2 == ${ERROR_SERVICE_DATABASE_LOCKED}
StrCpy $R0 1
${EndIf}
${EndIf}
System::Call `advapi32::CloseServiceHandle(i R1)`
${EndIf}

Pop $R2
Pop $R1
Exch $R0
FunctionEnd</highlight-nsis>
=== Usage ===
<highlight-nsis>Call IsUserAdmin
Pop $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Check if the current user is an Administrator

2012-06-25T05:16:27Z

550771955: /* Macro 3 (Windows 2k or above, by jiake) */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

There are 3 alternative implementations (2 macros and 1 function).

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

=== Macro 3 (Windows 2k or above, by jiake) ===
Today an NSIS user in our QQ group ask for this question again: how to determine whether the current user is an administrator user. I found that a Windows API can get the information of the specified user name, it's more easier than the above ways, I write it and so add it here.
<highlight-nsis>
!define USER_PRIV_GUEST 0
!define USER_PRIV_USER 1
!define USER_PRIV_ADMIN 2

!include "Util.nsh"
!define GetUserLevel "!insertmacro Call_GetUserLevel"
!macro Call_GetUserLevel _level _username
!verbose push
!verbose 3
Push ${_username}
${CallArtificialFunction} Func_GetUserLevel
Pop ${_level}
!verbose pop
!macroend
!macro Func_GetUserLevel
Exch $R0
Push $R1
System::Call "*(i)i.R1"
System::Call "netapi32::NetUserGetInfo(in,wR0,i1,iR1)i.R0"
IntCmp $R0 0 +3
Push error
Goto lbl_end
System::Call "*$R1(i.R0)"
System::Call "*$R0(w,w,i,i.s)"
System::Call "netapi32::NetApiBufferFree(iR0)"
lbl_end:
System::Free $R1
Exch
Pop $R1
Exch
Pop $R0
!macroend
</highlight-nsis>
Usage:
<highlight-nsis>
${GetUserLevel} VAR_USER_LEVEL_OUT STRING_OR_VAR_USERNAME
STRING_OR_VAR_USERNAME:
A valid username.
VAR_USER_LEVEL_OUT
A varible to store the result, it can be:
${USER_PRIV_GUEST} A guest account.
${USER_PRIV_USER} A Limited account.
${USER_PRIV_ADMIN} An administrator account.
error A error ocurred while calling.
</highlight-nsis>
Example:
<highlight-nsis>
ReadEnvStr $R0 UserName
${GetUserLevel} $0 $R0
MessageBox MB_OK "The user $R0's level is $0."
${GetUserLevel} $0 Administrator
MessageBox MB_OK "The user Administrator's level is $0."
</highlight-nsis>

== Function (by Afrow UK) ==
Based on [http://vcfaq.mvps.org/sdk/21.htm this code]
Note: After testing in the field, this function does not always work. Use the other function or use the included NSIS UserInfo plug-in (UserInfo::GetAccountType).<highlight-nsis>!define SC_MANAGER_LOCK 8
!define ERROR_SERVICE_DATABASE_LOCKED 1055

Function IsUserAdmin
Push $R0
Push $R1
Push $R2

StrCpy $R0 0

System::Call `advapi32::OpenSCManager(i 0, i 0, i ${SC_MANAGER_LOCK}) i.R1`
${If} $R1 != 0
System::Call `advapi32::LockServiceDatabase(i R1) i.R2`
${If} $R2 != 0
System::Call `advapi32::UnlockServiceDatabase(i R2)`
StrCpy $R0 1
${Else}
System::Call `kernel32::GetLastError() i.R2`
${If} $R2 == ${ERROR_SERVICE_DATABASE_LOCKED}
StrCpy $R0 1
${EndIf}
${EndIf}
System::Call `advapi32::CloseServiceHandle(i R1)`
${EndIf}

Pop $R2
Pop $R1
Exch $R0
FunctionEnd</highlight-nsis>
=== Usage ===
<highlight-nsis>Call IsUserAdmin
Pop $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Check if the current user is an Administrator

2012-06-25T05:14:56Z

550771955: /* Macros */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

There are 3 alternative implementations (2 macros and 1 function).

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

=== Macro 3 (Windows 2k or above, by jiake) ===
Today an NSIS user in our QQ group ask for this question again: how to determine whether the current user is an administrator user. I found that a Windows API can get the information of the specified user name, it's more easier than the above ways, I write it and so add it here.
<highlight-nsis>
!define USER_PRIV_GUEST 0
!define USER_PRIV_USER 1
!define USER_PRIV_ADMIN 2

!include "Util.nsh"
!define GetUserLevel "!insertmacro Call_GetUserLevel"
!macro Call_GetUserLevel _level _username
!verbose push
!verbose 3
Push ${_username}
${CallArtificialFunction} Func_GetUserLevel
Pop ${_level}
!verbose pop
!macroend
!macro Func_GetUserLevel
Exch $R0
Push $R1
System::Call "*(i)i.R1"
System::Call "netapi32::NetUserGetInfo(in,wR0,i1,iR1)i.R0"
IntCmp $R0 0 +3
Push error
Goto lbl_end
System::Call "*$R1(i.R0)"
System::Call "*$R0(w,w,i,i.s)"
System::Call "netapi32::NetApiBufferFree(iR0)"
lbl_end:
System::Free $R1
Exch
Pop $R1
Exch
Pop $R0
!macroend
</highlight-nsis>
Usage:
<highlight-nsis>
${GetUserLevel} VAR_USER_LEVEL_OUT STRING_OR_VAR_USERNAME
STRING_OR_VAR_USERNAME:
A valid username.
VAR_USER_LEVEL_OUT
A varible. It can be:
${USER_PRIV_GUEST} A guest account.
${USER_PRIV_USER} A Limited account.
${USER_PRIV_ADMIN} An administrator account.
error A error ocurred while calling.
</highlight-nsis>
Example:
<highlight-nsis>
ReadEnvStr $R0 UserName
${GetUserLevel} $0 $R0
MessageBox MB_OK "The user $R0's level is $0."
${GetUserLevel} $0 Administrator
MessageBox MB_OK "The user Administrator's level is $0."
</highlight-nsis>

== Function (by Afrow UK) ==
Based on [http://vcfaq.mvps.org/sdk/21.htm this code]
Note: After testing in the field, this function does not always work. Use the other function or use the included NSIS UserInfo plug-in (UserInfo::GetAccountType).<highlight-nsis>!define SC_MANAGER_LOCK 8
!define ERROR_SERVICE_DATABASE_LOCKED 1055

Function IsUserAdmin
Push $R0
Push $R1
Push $R2

StrCpy $R0 0

System::Call `advapi32::OpenSCManager(i 0, i 0, i ${SC_MANAGER_LOCK}) i.R1`
${If} $R1 != 0
System::Call `advapi32::LockServiceDatabase(i R1) i.R2`
${If} $R2 != 0
System::Call `advapi32::UnlockServiceDatabase(i R2)`
StrCpy $R0 1
${Else}
System::Call `kernel32::GetLastError() i.R2`
${If} $R2 == ${ERROR_SERVICE_DATABASE_LOCKED}
StrCpy $R0 1
${EndIf}
${EndIf}
System::Call `advapi32::CloseServiceHandle(i R1)`
${EndIf}

Pop $R2
Pop $R1
Exch $R0
FunctionEnd</highlight-nsis>
=== Usage ===
<highlight-nsis>Call IsUserAdmin
Pop $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Header file for Listview

2011-05-15T01:58:40Z

550771955: /* Example 2 */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for common windows:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles of a control. Note, the following text come from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles of a control. It may not take effect in some cases for the above saying.

'''2. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''3. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx. You can find the function introduction of each message and their parameters on MSDN.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd iCol cx szText
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd iItem szText
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd iItem iSubItem szText
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i32,i32,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 32.
System::Call 'comctl32::ImageList_Create(i32,i32,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-04-21T08:13:36Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for common windows:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles of a control. Note, the following text come from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles of a control. It may not take effect in some cases for the above saying.

'''2. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''3. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx. You can find the function introduction of each message and their parameters on MSDN.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd iCol cx szText
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd iItem szText
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd iItem iSubItem szText
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

File:ListView.zip

2011-04-21T08:06:32Z

550771955: uploaded a new version of "File:ListView.zip"

File:ListView.zip

2011-03-25T15:35:43Z

550771955: uploaded a new version of "File:ListView.zip": Update scripts and examples

Header file for Listview

2011-02-28T10:20:34Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for common windows:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles of a control. Note, the following text come from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles of a control. It may not take effect in some cases for the above saying.

'''2. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''3. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx. You can find the function introduction of each message and their parameters on MSDN.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd iCol cx szText
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd iItem szText
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd iItem iSubItem szText
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-28T10:17:53Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for common windows:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles of a control. Note, the following text come from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles of a control. It may not take effect in some cases for the above saying.

'''2. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''3. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx. You can the function introduction of each message and their parameters on MSDN.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd iCol cx szText
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd iItem szText
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd iItem iSubItem szText
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-28T10:09:15Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for common windows:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles of a control. Note, the following text come from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles of a control. It may not take effect in some cases for the above saying.

'''2. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''3. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon' of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx. You can the function introduction of each message and their parameters on MSDN.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd iCol cx szText
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd iItem szText
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd iItem iSubItem szText
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-28T04:22:58Z

550771955: /* Example 1 */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles of a control. Note, the following text come from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles of a control. It may not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''2. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon' of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx. You can the function introduction of each message and their parameters on MSDN.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd iCol cx szText
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd iItem szText
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd iItem iSubItem szText
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T20:15:12Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles of a control. Note, the following text come from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles of a control. It may not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''2. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon' of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx. You can the function introduction of each message and their parameters on MSDN.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T20:11:43Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles from a control. Note, from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''2. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon' of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx. You can the function introduction of each message and their parameters on MSDN.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T20:08:08Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles from a control. Note, from MSDN: For some styles in certain controls (For example, add the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style to an edit control will not make it read-only), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''2. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon' of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn. All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T20:05:38Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''1. Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window styles from a control. Note, from MSDN: For some styles in certain controls (the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available.

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window styles from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox String</highlight-nsis>
Deletes the specified string from the ComboBox control. Note: If the string you specified doesn't exist in the ComboBox, the first string that contains what you specified will be deleted. For example: there are 4 items in the ComboBox: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the count of strings in the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control. The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this header. Note: If the string you specified is not exist in the ListBox, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value). The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the ListBox. This macro is redefined like the above one, it doesn't return any value.

'''2. New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon' of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn. All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T19:57:31Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window style from a control. Note, from MSDN: For some styles in certain controls (the [http://msdn.microsoft.com/en-us/library/bb775464.aspx ES_READONLY] style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the total number of strings of the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

'''New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as [http://msdn.microsoft.com/en-us/library/bb774894.aspx LVM_DELETECOLUMN] message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as [http://msdn.microsoft.com/en-us/library/bb774895.aspx LVM_DELETEITEM] message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon' of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send [http://msdn.microsoft.com/en-us/library/bb761178.aspx LVM_SETIMAGELIST] message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the [http://msdn.microsoft.com/en-us/library/bb761165.aspx LVM_SETEXTENDEDLISTVIEWSTYLE] message to set the [http://msdn.microsoft.com/en-us/library/bb774732.aspx LVS_EX_CHECKBOXES] extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn. All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T19:50:33Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS Chinese forum "www.dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me later. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

'''Additional macros for ListBox and ComboBox:'''

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window style from a control. Note, from MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings of the ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the total number of strings of the ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string of the ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string of the ListBox control.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings of the ListBox control (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

'''New macros for ListView control:'''

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to the ListView control. To delete a column from the ListView control, just send the LVM_DELETECOLUMN message: SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column of the ListView control. Same as LVM_DELETECOLUMN message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to the ListView control. To delete an item from the ListView control, just send the LVM_DELETECOLUMN message: SendMessage hListview ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item of the ListView control (report view). Same as LVM_DELETEITEM message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem of the ListView control. To retrieve an item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (videlicet, inserts a new subitem) of the ListView control. To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the associated bitmap or icon' of an item in the ListView control. Before using this you must create an ImageList first that contains one or more bitmaps or icons, and send LVM_SETIMAGELIST message to associate the ImageList with the ListView control. Then you should pass the zero-based index of the image in the ImageList to "iImage". See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the check state of an item in a listview control with checkboxes extended style. Result may be 1, which represents the item is checked, or 0, represents unchecked. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or unchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn. All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

The original author of this header adds more controls support and more macros in this header, therefore it is renamed to "CommCtrl.nsh". As more controls support will be added in future, and this page will also be updated. If you have any suggestions you may contact with gfm688: 395177116#qq.com, or me: 550771955#qq.com.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T15:20:51Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macros in this header:

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings from a ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the number of strings from a ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string from a ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string from a ListBox control.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings from a ListBox control (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to a listview control (report view). To delete a column from a listview control, just sending the LVM_DELETECOLUMN message - SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column from a listview control (report view). Same as LVM_DELETECOLUMN message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to a listview control (report view). To delete an item from a listview control, just sending the LVM_DELETECOLUMN message - SendMessage listview_HWND ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item from a listview control (report view). Same as LVM_DELETEITEM message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem from an item of listview control (report view). To retrieve the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (inserts a new subitem) to an item of listview control (report view). To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the icon of an item of listview (report view). Before using this you must create an ImageList first that contains one or more bitmaps or icons. See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the state of an item in a listview control with checkboxes extended style. Result may be 1, represents the item is checked, or 0 represents unchecked. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or umchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn. All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T15:20:04Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me. I add some new macros, include some for ComboBox and ListBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macros in this header:

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings from a ComboBox control (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the number of strings from a ComboBox control.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string from a ComboBox control.

* <highlight-nsis>${NSD_LB_DelString} hListBox String #redefined in header</highlight-nsis>
Deletes the specified string from a ListBox control.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox #redefined in header</highlight-nsis>
Deletes all strings from a ListBox control (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to a listview control (report view). To delete a column from a listview control, just sending the LVM_DELETECOLUMN message - SendMessage hListview ${LVM_DELETECOLUMN} iCol 0.

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column from a listview control (report view). Same as LVM_DELETECOLUMN message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to a listview control (report view). To delete an item from a listview control, just sending the LVM_DELETECOLUMN message - SendMessage listview_HWND ${LVM_DELETEITEM} iItem 0.

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item from a listview control (report view). Same as LVM_DELETEITEM message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem from an item of listview control (report view). To retrieve the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (inserts a new subitem) to an item of listview control (report view). To set the item's text, pass iSubItem with 0 (zero).

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the icon of an item of listview (report view). Before using this you must create an ImageList first that contains one or more bitmaps or icons. See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the state of an item in a listview control with checkboxes extended style. Result may be 1, represents the item is checked, or 0 represents unchecked. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or umchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 (one) to check it or 0 (zero) to uncheck it. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

To set the text color, background color, set column width, etc. You can also using SendMessage simplely.

For example:
SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.
SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.
SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn. All messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T15:09:59Z

550771955: /* Example 2 */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me, I add some new macro commands, include some macro commands for ComboBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macros in this header:

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings from a combobox (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the number of strings from a combobox.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string from a combobox.

* <highlight-nsis>${NSD_LB_DelString} hListBox String # the redefined one</highlight-nsis>
Deletes the specified string from a list box.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox # the redefined one</highlight-nsis>
Deletes all strings from a list box (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to a listview control (report view). It is very easy to delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage hListview ${LVM_DELETECOLUMN} iCol 0".

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column from a listview control (report view). Same as LVM_DELETECOLUMN message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to a listview control (report view). To delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETEITEM} iItem 0".

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item from a listview control (report view). Same as LVM_DELETEITEM message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem from an item of listview control (report view). To retrieve the item's text, pass iSubItem with zero.

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (inserts a new subitem) to an item of listview control (report view). To set the item's text, pass iSubItem with zero.

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the icon of an item of listview (report view). Before using this you must create an ImageList first that contains one or more bitmaps or icons. See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the state of an item in a listview control with checkboxes extended style. Result may be 1, represents the item is checked, or 0 represents unchecked. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or umchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 to check it or 0 to uncheck it. Before using thsi you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

It is very easy to set the text color, background color, set column width, etc. you can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn.

See all messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(ir0,i9,i${IMAGE_ICON},i16,i16,i${LR_SHARED})i.R1'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T15:06:53Z

550771955: /* Example 1 */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me, I add some new macro commands, include some macro commands for ComboBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macros in this header:

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings from a combobox (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the number of strings from a combobox.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string from a combobox.

* <highlight-nsis>${NSD_LB_DelString} hListBox String # the redefined one</highlight-nsis>
Deletes the specified string from a list box.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox # the redefined one</highlight-nsis>
Deletes all strings from a list box (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to a listview control (report view). It is very easy to delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage hListview ${LVM_DELETECOLUMN} iCol 0".

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column from a listview control (report view). Same as LVM_DELETECOLUMN message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to a listview control (report view). To delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETEITEM} iItem 0".

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item from a listview control (report view). Same as LVM_DELETEITEM message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem from an item of listview control (report view). To retrieve the item's text, pass iSubItem with zero.

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (inserts a new subitem) to an item of listview control (report view). To set the item's text, pass iSubItem with zero.

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the icon of an item of listview (report view). Before using this you must create an ImageList first that contains one or more bitmaps or icons. See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the state of an item in a listview control with checkboxes extended style. Result may be 1, represents the item is checked, or 0 represents unchecked. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or umchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 to check it or 0 to uncheck it. Before using thsi you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

It is very easy to set the text color, background color, set column width, etc. you can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn.

See all messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "CommCtrl.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0

StrCmp $0 error 0 +2
Abort

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetItemText} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetItemText} $1 0 1 'Subitem 0_1'
${NSD_LV_SetItemText} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetItemText} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetItemText} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]

== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(i,t,i,i,i,i)i(r0,i9,${IMAGE_ICON},r7,r8,${LR_SHARED}).R1'
; Free the handle of shell32.dll.
System::Call 'user32::FreeLibrary(ir0)'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show

; Destroy the image list
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2011-02-25T15:04:13Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me, I add some new macro commands, include some macro commands for ComboBox.

See this attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macros in this header:

* <highlight-nsis>${NSD_RemoveStyle} hWnd Styles</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} hWnd ExStyles</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} hComboBox string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} hComboBox</highlight-nsis>
Deletes all strings from a combobox (no return value).

* <highlight-nsis>${NSD_CB_GetCount} hComboBox outVar</highlight-nsis>
Retrieves the number of strings from a combobox.

* <highlight-nsis>${NSD_CB_GetSelection} hComboBox outVar</highlight-nsis>
Retrieves the selected string from a combobox.

* <highlight-nsis>${NSD_LB_DelString} hListBox String # the redefined one</highlight-nsis>
Deletes the specified string from a list box.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} hListBox # the redefined one</highlight-nsis>
Deletes all strings from a list box (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} hListview iCol cx szText</highlight-nsis>
Inserts a new column to a listview control (report view). It is very easy to delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage hListview ${LVM_DELETECOLUMN} iCol 0".

* <highlight-nsis>${NSD_LV_DeleteColumn} hListview iCol</highlight-nsis>
Deletes a column from a listview control (report view). Same as LVM_DELETECOLUMN message.

* <highlight-nsis>${NSD_LV_InsertItem} hListview iItem szText</highlight-nsis>
Inserts a new item to a listview control (report view). To delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETEITEM} iItem 0".

* <highlight-nsis>${NSD_LV_DeleteItem} hListview iItem</highlight-nsis>
Deletes an item from a listview control (report view). Same as LVM_DELETEITEM message.

* <highlight-nsis>${NSD_LV_GetItemText} hListview iItem iSubItem outVar</highlight-nsis>
Retrieves the text of an item or its subitem from an item of listview control (report view). To retrieve the item's text, pass iSubItem with zero.

* <highlight-nsis>${NSD_LV_SetItemText} hListview iItem iSubItem szText</highlight-nsis>
Sets the text of an item or its subitem (inserts a new subitem) to an item of listview control (report view). To set the item's text, pass iSubItem with zero.

* <highlight-nsis>${NSD_LV_SetItemImage} hListview iItem iImage</highlight-nsis>
Sets the icon of an item of listview (report view). Before using this you must create an ImageList first that contains one or more bitmaps or icons. See examples in the above attachment for details.

* <highlight-nsis>${NSD_LV_GetCheckState} hListview iItem outVar</highlight-nsis>
Retrieves the state of an item in a listview control with checkboxes extended style. Result may be 1, represents the item is checked, or 0 represents unchecked. Before using this you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

* <highlight-nsis>${NSD_LV_SetCheckState} hListview iItem State</highlight-nsis>
Checks or umchecks an item in a listview control with checkboxes extended style. Pass "State" with 1 to check it or 0 to uncheck it. Before using thsi you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style.

It is very easy to set the text color, background color, set column width, etc. you can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn.

See all messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961.aspx.

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetSubItem} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetSubItem} $1 0 1 'Subitem 0_1'
${NSD_LV_SetSubItem} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetSubItem} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetSubItem} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]
== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(i,t,i,i,i,i)i(r0,i9,${IMAGE_ICON},r7,r8,${LR_SHARED}).R1'
; Free the handle of shell32.dll.
System::Call 'user32::FreeLibrary(ir0)'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show

; Destroy the image list
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

File:ListView.zip

2011-02-25T14:42:07Z

550771955: uploaded a new version of "File:ListView.zip": Change some macro names, add new macros and update example.

Header file for Listview

2011-01-27T07:43:37Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me, I add some new macro commands, include some macro commands for ComboBox.

See the attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macro commands in this file:

* <highlight-nsis>${NSD_RemoveStyle} control_HWND style</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} control_HWND style</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} combo_HWND string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} combo_HWND</highlight-nsis>
Deletes all strings from a combobox (no return value).

* <highlight-nsis>${NSD_CB_GetCount} combo_HWND output_var</highlight-nsis>
Retrieves the number of strings from a combobox.

* <highlight-nsis>${NSD_CB_GetSelection} combo_HWND output_var</highlight-nsis>
Retrieves the selected string from a combobox.

* <highlight-nsis>${NSD_LB_DelString} listbox_HWND string # the redefined one</highlight-nsis>
Deletes the specified string from a list box.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} listbox_HWND # the redefined one</highlight-nsis>
Deletes all strings from a list box (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} listview_HWND col_idx col_width text</highlight-nsis>
Inserts a new column to a listview (report view). It is very easy to delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETECOLUMN} col_idx 0".

* <highlight-nsis>${NSD_LV_InsertItem} listview_HWND item_idx text</highlight-nsis>
Inserts a new item to a listview (report view). To delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETEITEM} item_idx 0".

* <highlight-nsis>${NSD_LV_SetSubItem} listview_HWND item_idx subitem_idx text</highlight-nsis>
Inserts a new subitem to an item of listview (report view).

* <highlight-nsis>${NSD_LV_SetItemIcon} listview_HWND item_idx icon_idx</highlight-nsis>
Sets the icon of an item of listview (report view). Before using you must first create an image list that contain the handle of one or more bitmap or icon. See examples in the attachment for details.

* <highlight-nsis>${NSD_LV_SetItemChecked} listview_HWND item_idx</highlight-nsis>
Checks an item of a listview with checkboxes extended style. Before using you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style take effect.

* <highlight-nsis>${NSD_LV_GetItemText} listview_HWND item_idx subitem_idx output_var</highlight-nsis>
Retrieves the text of an item of a listview. To retrieve the item text, set subitem_idx to zero.

It is very easy to set the text color, background color, delete column, delete item, set column width, etc. you can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn.

See all messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961

[[Category:Headers]]

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetSubItem} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetSubItem} $1 0 1 'Subitem 0_1'
${NSD_LV_SetSubItem} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetSubItem} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetSubItem} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]
== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(i,t,i,i,i,i)i(r0,i9,${IMAGE_ICON},r7,r8,${LR_SHARED}).R1'
; Free the handle of shell32.dll.
System::Call 'user32::FreeLibrary(ir0)'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show

; Destroy the image list
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Check open ports

2010-11-05T08:23:55Z

550771955: /* Usage */

Below is a function allowing you to test for open UDP and TCP ports on the local computer. Use this to check if the user selected port is free, if Apache can run with the default configuration or if your favorite port hasn't been stolen by another.

This code uses iphlpapi.dll which is only available on Windows 98 and above and NT 4.0 SP4 and above.
== Usage ==
First, save Ports.nsh from the code snippet at the end of this page to Ports.nsh. Next, include it into your script.
<highlight-nsis>!include "Ports.nsh"</highlight-nsis>
Now, to check for open TCP ports, use the following.
<highlight-nsis>${Unless} ${TCPPortOpen} 80
MessageBox MB_OK "httpd running"
${EndUnless}</highlight-nsis>
To check for open UDP ports, only a slight modification is required.
<highlight-nsis>${If} ${UDPPortOpen} 1337
MessageBox MB_OK "leet port open :)"
${EndIf}</highlight-nsis>

== Ports.nsh ==
<highlight-nsis># Usage:
# Push "Tcp" or "Udp"
# Push "port_number"
# Call IsPortOpen
# Pop $0 ; "open" or "closed" or anything else for error
#
# Or with the LogicLib
# ${If} ${TCPPortOpen} 80
# ${EndIf}
# ${If} ${UDPPortOpen} 137
# ${EndIf}
#
Function IsPortOpen

Exch $R0 # port to check
Exch
Exch $R1
Push $0
Push $1
Push $2

System::Call 'iphlpapi::Get$R1Table(*i.r0, *i .r1, i 1) i .r2'
${If} $2 != 122 # ERROR_INSUFFICIENT_BUFFER
StrCpy $R0 ""
Pop $2
Pop $1
Pop $0
Exch $R1
Exch
Exch $R0
Return
${EndIf}

System::Alloc $1
Pop $0

System::Call 'iphlpapi::Get$R1Table(ir0, *i r1, i 1) i .r2'
${If} $2 != 0 # NO_ERROR
System::Free $0
StrCpy $R0 ""
Pop $2
Pop $1
Pop $0
Exch $R1
Exch
Exch $R0
Return
${EndIf}

Push $3
Push $4
Push $5

System::Call *$0(i.r2)
IntOp $2 $2 - 1
${For} $3 0 $2
IntOp $4 $0 + 4 # skip dwNumEntries
${If} $R1 == "Tcp"
IntOp $5 $3 * 20 # sizeof(MIB_TCPROW)
IntOp $4 $4 + $5 # skip to entry
System::Call *$4(i,i,i.r4,i,i)
${Else}
IntOp $5 $3 * 8 # sizeof(MIB_UDPROW)
IntOp $4 $4 + $5 # skip to entry
System::Call *$4(i,i.r4)
${EndIf}
System::Call ws2_32::ntohs(ir4)i.r4

${If} $4 = $R0
StrCpy $R0 "open"
${Break}
${EndIf}
${Next}

${If} $R0 != "open"
StrCpy $R0 "closed"
${EndIf}

System::Free $0

Pop $5
Pop $4
Pop $3
Pop $2
Pop $1
Pop $0
Exch $R1
Exch
Exch $R0

FunctionEnd

# LogicLib macros for IsPortOpen

!include LogicLib.nsh

!macro _PortOpen _a _b _t _f
!insertmacro _LOGICLIB_TEMP
Push `${_a}`
Push `${_b}`
Call IsPortOpen
Pop $_LOGICLIB_TEMP
!insertmacro _== $_LOGICLIB_TEMP "open" `${_t}` `${_f}`
!macroend
!define PortOpen `PortOpen`

!macro _TCPPortOpen _a _b _t _f
!insertmacro _PortOpen Tcp `${_b}` `${_t}` `${_f}`
!macroend
!define TCPPortOpen `"" TCPPortOpen`

!macro _UDPPortOpen _a _b _t _f
!insertmacro _PortOpen Udp `${_b}` `${_t}` `${_f}`
!macroend
!define UDPPortOpen `"" UDPPortOpen`</highlight-nsis>

[[Category:System Plugin Examples]]
[[Category:Internet Functions]]

Header file for Listview

2010-09-13T11:26:45Z

550771955: /* Example 2 */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me, I add some new macro commands, include some macro commands for ComboBox.

See the attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macro commands in this file:

* <highlight-nsis>${NSD_RemoveStyle} control_HWND style</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} control_HWND style</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} combo_HWND string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} combo_HWND</highlight-nsis>
Deletes all strings from a combobox (no return value).

* <highlight-nsis>${NSD_CB_GetCount} combo_HWND output_var</highlight-nsis>
Retrieves the number of strings from a combobox.

* <highlight-nsis>${NSD_CB_GetSelection} combo_HWND output_var</highlight-nsis>
Retrieves the selected string from a combobox.

* <highlight-nsis>${NSD_LB_DelString} listbox_HWND string # the redefined one</highlight-nsis>
Deletes the specified string from a list box.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} listbox_HWND # the redefined one</highlight-nsis>
Deletes all strings from a list box (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} listview_HWND col_idx col_width text</highlight-nsis>
Inserts a new column to a listview (report view). It is very easy to delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETECOLUMN} col_idx 0".

* <highlight-nsis>${NSD_LV_InsertItem} listview_HWND item_idx text</highlight-nsis>
Inserts a new item to a listview (report view). To delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETEITEM} item_idx 0".

* <highlight-nsis>${NSD_LV_SetSubItem} listview_HWND item_idx subitem_idx text</highlight-nsis>
Inserts a new subitem to an item of listview (report view).

* <highlight-nsis>${NSD_LV_SetItemIcon} listview_HWND item_idx icon_idx</highlight-nsis>
Sets the icon of an item of listview (report view). Before using you must first create an image list that contain the handle of one or more bitmap or icon. See examples in the attachment for details.

* <highlight-nsis>${NSD_LV_SetItemChecked} listview_HWND item_idx</highlight-nsis>
Checks an item of a listview with checkboxes extended style. Before using you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style take effect.

* <highlight-nsis>${NSD_LV_GetItemText} listview_HWND item_idx subitem_idx output_var</highlight-nsis>
Retrieves the text of an item of a listview. To retrieve the item text, set subitem_idx to zero.

It is very easy to set the text color, background color, delete column, delete item, set column width, etc. you can also using SendMessage simplely.

For example:

SendMessage $HWND ${LVM_DELETEITEM} 2 0, deletes the 2nd (zero-based) item.

SendMessage $HWND ${LVM_DELETECOLUMN} 4 0, deletes the 4th (zero-based) column.

SendMessage $HWND ${LVM_SETBKCOLOR} 0 0xFF0000, sets the background color to red.

Parameters of each message can be found on msdn.

See all messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetSubItem} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetSubItem} $1 0 1 'Subitem 0_1'
${NSD_LV_SetSubItem} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetSubItem} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetSubItem} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]
== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::LoadLibrary(t"shell32.dll")i.r0'
; Load the 9th icon of small size in shell32.dll.
System::Call 'user32::LoadImage(i,t,i,i,i,i)i(r0,i9,${IMAGE_ICON},r7,r8,${LR_SHARED}).R1'
; Free the handle of shell32.dll.
System::Call 'user32::FreeLibrary(ir0)'
; Create an imagelist, width and height of each image is 16.
System::Call 'comctl32::ImageList_Create(i16,i16,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show

; Destroy the image list
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

File:ListView.zip

2010-09-10T04:49:13Z

550771955: uploaded a new version of "File:ListView.zip"

File:ListView.zip

2010-09-10T03:50:52Z

550771955: uploaded a new version of "File:ListView.zip"

Header file for Listview

2010-08-02T02:20:42Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me, I add some new macro commands, include some macro commands for ComboBox.

See the attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macro commands in this file:

* <highlight-nsis>${NSD_RemoveStyle} control_HWND style</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), it may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} control_HWND style</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} combo_HWND string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} combo_HWND</highlight-nsis>
Deletes all strings from a combobox (no return value).

* <highlight-nsis>${NSD_CB_GetCount} combo_HWND output_var</highlight-nsis>
Retrieves the number of strings from a combobox.

* <highlight-nsis>${NSD_CB_GetSelection} combo_HWND output_var</highlight-nsis>
Retrieves the selected string from a combobox.

* <highlight-nsis>${NSD_LB_DelString} listbox_HWND string # the redefined one</highlight-nsis>
Deletes the specified string from a list box.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} listbox_HWND # the redefined one</highlight-nsis>
Deletes all strings from a list box (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} listview_HWND col_idx col_width text</highlight-nsis>
Inserts a new column to a listview (report view). It is very easy to delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETECOLUMN} col_idx 0".

* <highlight-nsis>${NSD_LV_InsertItem} listview_HWND item_idx text</highlight-nsis>
Inserts a new item to a listview (report view). To delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETEITEM} item_idx 0".

* <highlight-nsis>${NSD_LV_SetSubItem} listview_HWND item_idx subitem_idx text</highlight-nsis>
Inserts a new subitem to an item of listview (report view).

* <highlight-nsis>${NSD_LV_SetItemIcon} listview_HWND item_idx icon_idx</highlight-nsis>
Sets the icon of an item of listview (report view). Before using you must first create an image list that contain the handle of one or more bitmap or icon. See examples in the attachment for details.

* <highlight-nsis>${NSD_LV_SetItemChecked} listview_HWND item_idx</highlight-nsis>
Checks an item of a listview with checkboxes extended style. Before using you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style take effect.

* <highlight-nsis>${NSD_LV_GetItemText} listview_HWND item_idx subitem_idx output_var</highlight-nsis>
Retrieves the text of an item of a listview. To retrieve the item text, set subitem_idx to zero.

It is very easy to set the text color, background color, delete column, delete item, set column width, etc. you can also using SendMessage simplely. See all messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetSubItem} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetSubItem} $1 0 1 'Subitem 0_1'
${NSD_LV_SetSubItem} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetSubItem} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetSubItem} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]
== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the recommended width and height of an icon.
System::Call 'user32::GetSystemMetrics(i${SM_CXICON})i.r7'
System::Call 'user32::GetSystemMetrics(i${SM_CYICON})i.r8'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::GetModuleHandle(t"shell32.dll")i.r0'
; Load the 9th icon of recommended size in shell32.dll.
System::Call 'user32::LoadImage(i,t,i,i,i,i)i(r0,i9,${IMAGE_ICON},r7,r8,${LR_SHARED})i.R1'
; Free the handle of shell32.dll.
System::Call 'user32::FreeLibrary(ir0)'
; Create an imagelist, width of each image is $7 and height is $8.
System::Call 'comctl32::ImageList_Create(ir7,ir8,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show

; Destroy the image list
${NSD_FreeImage} $R1
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2010-08-02T02:19:17Z

550771955: /* Header file for creating Listview control */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me, I add some new macro commands, include some macro commands for ComboBox.

See the attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macro commands in this file:

* <highlight-nsis>${NSD_RemoveStyle} control_HWND style</highlight-nsis>
Removes one or more window style from a control. From MSDN: For some styles in certain controls (the ES_READONLY style in the edit control, for example), this may not properly change the style because the control may need to perform special internal processing. In these cases, a corresponding message to change the style will be available (EM_SETREADONLY in the example mentioned).

* <highlight-nsis>${NSD_RemoveExStyle} control_HWND style</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} combo_HWND string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} combo_HWND</highlight-nsis>
Deletes all strings from a combobox (no return value).

* <highlight-nsis>${NSD_CB_GetCount} combo_HWND output_var</highlight-nsis>
Retrieves the number of strings from a combobox.

* <highlight-nsis>${NSD_CB_GetSelection} combo_HWND output_var</highlight-nsis>
Retrieves the selected string from a combobox.

* <highlight-nsis>${NSD_LB_DelString} listbox_HWND string # the redefined one</highlight-nsis>
Deletes the specified string from a list box.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} listbox_HWND # the redefined one</highlight-nsis>
Deletes all strings from a list box (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} listview_HWND col_idx col_width text</highlight-nsis>
Inserts a new column to a listview (report view). It is very easy to delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETECOLUMN} col_idx 0".

* <highlight-nsis>${NSD_LV_InsertItem} listview_HWND item_idx text</highlight-nsis>
Inserts a new item to a listview (report view). To delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETEITEM} item_idx 0".

* <highlight-nsis>${NSD_LV_SetSubItem} listview_HWND item_idx subitem_idx text</highlight-nsis>
Inserts a new subitem to an item of listview (report view).

* <highlight-nsis>${NSD_LV_SetItemIcon} listview_HWND item_idx icon_idx</highlight-nsis>
Sets the icon of an item of listview (report view). Before using you must first create an image list that contain the handle of one or more bitmap or icon. See examples in the attachment for details.

* <highlight-nsis>${NSD_LV_SetItemChecked} listview_HWND item_idx</highlight-nsis>
Checks an item of a listview with checkboxes extended style. Before using you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style take effect.

* <highlight-nsis>${NSD_LV_GetItemText} listview_HWND item_idx subitem_idx output_var</highlight-nsis>
Retrieves the text of an item of a listview. To retrieve the item text, set subitem_idx to zero.

It is very easy to set the text color, background color, delete column, delete item, set column width, etc. you can also using SendMessage simplely. See all messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetSubItem} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetSubItem} $1 0 1 'Subitem 0_1'
${NSD_LV_SetSubItem} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetSubItem} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetSubItem} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]
== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the recommended width and height of an icon.
System::Call 'user32::GetSystemMetrics(i${SM_CXICON})i.r7'
System::Call 'user32::GetSystemMetrics(i${SM_CYICON})i.r8'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::GetModuleHandle(t"shell32.dll")i.r0'
; Load the 9th icon of recommended size in shell32.dll.
System::Call 'user32::LoadImage(i,t,i,i,i,i)i(r0,i9,${IMAGE_ICON},r7,r8,${LR_SHARED})i.R1'
; Free the handle of shell32.dll.
System::Call 'user32::FreeLibrary(ir0)'
; Create an imagelist, width of each image is $7 and height is $8.
System::Call 'comctl32::ImageList_Create(ir7,ir8,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show

; Destroy the image list
${NSD_FreeImage} $R1
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

Header file for Listview

2010-07-28T02:20:38Z

550771955: /* Example 2 */

== Header file for creating Listview control ==

In an NSIS forum "dreams8.com", a member named "gfm688" writes a header file to create and handle a listview control with the report view. This header file is modified by me, I add some new macro commands, include some macro commands for ComboBox.

See the attachment for details, 8 examples included.

<attach>ListView.zip</attach>

All macro commands in this file:

* <highlight-nsis>${NSD_RemoveStyle} control_HWND style</highlight-nsis>
Removes one or more window style from a control. May not take effect in some cases as the ES_READONLY style of an edit control.

* <highlight-nsis>${NSD_RemoveExStyle} control_HWND style</highlight-nsis>
Removes one or more extended window style from a control. May not take effect in some cases for the above saying.

* <highlight-nsis>${NSD_CB_DelString} combo_HWND string</highlight-nsis>
Deletes the specified string from a combobox. Note: If the string you specified is not exist in a combo box, the first string that contains what you specified will be deleted. For example: there are 4 items in a combo box: First, Second, Seconds, Secondary. If you want to delete the string "sec", the first one which contains "sec" from top - "Second" will be deleted.

* <highlight-nsis>${NSD_CB_Clear} combo_HWND</highlight-nsis>
Deletes all strings from a combobox (no return value).

* <highlight-nsis>${NSD_CB_GetCount} combo_HWND output_var</highlight-nsis>
Retrieves the number of strings from a combobox.

* <highlight-nsis>${NSD_CB_GetSelection} combo_HWND output_var</highlight-nsis>
Retrieves the selected string from a combobox.

* <highlight-nsis>${NSD_LB_DelString} listbox_HWND string # the redefined one</highlight-nsis>
Deletes the specified string from a list box.
The macro command NSD_LB_DelString in nsDialogs.nsh always deletes the first string but not the specified one. I write a new macro to replace it, and undefine the original one in this file. Note: If the string you specified is not exist in a list box, the first string that contains what you specified will be deleted.

* <highlight-nsis>${NSD_LB_Clear} listbox_HWND # the redefined one</highlight-nsis>
Deletes all strings from a list box (no return value).
The macro command NSD_LB_Clear in nsDialogs.nsh needs two parameters, but the readme file of nsDialogs said the macro needs only one parameter, it is exactly the handle of the listbox. This macro is redefined as the above one, it doesn't return a value.

* <highlight-nsis>${NSD_LV_InsertColumn} listview_HWND col_idx col_width text</highlight-nsis>
Inserts a new column to a listview (report view). It is very easy to delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETECOLUMN} col_idx 0".

* <highlight-nsis>${NSD_LV_InsertItem} listview_HWND item_idx text</highlight-nsis>
Inserts a new item to a listview (report view). To delete a column from a listview, just sending the LVM_DELETECOLUMN message to the listview - "SendMessage listview_HWND ${LVM_DELETEITEM} item_idx 0".

* <highlight-nsis>${NSD_LV_SetSubItem} listview_HWND item_idx subitem_idx text</highlight-nsis>
Inserts a new subitem to an item of listview (report view).

* <highlight-nsis>${NSD_LV_SetItemIcon} listview_HWND item_idx icon_idx</highlight-nsis>
Sets the icon of an item of listview (report view). Before using you must first create an image list that contain the handle of one or more bitmap or icon. See examples in the attachment for details.

* <highlight-nsis>${NSD_LV_SetItemChecked} listview_HWND item_idx</highlight-nsis>
Checks an item of a listview with checkboxes extended style. Before using you must send the LVM_SETEXTENDEDLISTVIEWSTYLE message to set the LVS_EX_CHECKBOXES extended style take effect.

* <highlight-nsis>${NSD_LV_GetItemText} listview_HWND item_idx subitem_idx output_var</highlight-nsis>
Retrieves the text of an item of a listview. To retrieve the item text, set subitem_idx to zero.

It is very easy to set the text color, background color, delete column, delete item, set column width, etc. you can also using SendMessage simplely. See all messages of listview control: http://msdn.microsoft.com/en-us/library/ff485961

== Example 1 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "A listview control created by nsDialogs"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
; ${NSD_LV_InsertColumn} hwnd col_idx_0_based col_width col_text
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 100 "column 1"
${NSD_LV_InsertColumn} $1 2 100 "column 2"
; ${NSD_LV_InsertItem} hwnd item_idx_0_based item_text
${NSD_LV_InsertItem} $1 0 'Item 0'
; ${NSD_LV_SetSubItem} hwnd item_idx_0_based subitem_idx_1_based subitem_text
${NSD_LV_SetSubItem} $1 0 1 'Subitem 0_1'
${NSD_LV_SetSubItem} $1 0 2 'Subitem 0_2'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_SetSubItem} $1 1 2 'Subitem 1_2'
${NSD_LV_InsertItem} $1 2 'Item 2'
${NSD_LV_SetSubItem} $1 2 1 'Subitem 2_1'

nsDialogs::Show

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview1.png]]
== Example 2 ==

<highlight-nsis>
/* Listview styles are defined in header file */
!include "MUI2.nsh"
!include "ListView.nsh"

Name "List View Example"
OutFile ListView.exe

Page custom CreatePage
!insertmacro MUI_LANGUAGE "English"

Function CreatePage

!insertmacro MUI_HEADER_TEXT "List view" "Using icon resource from system dll as image list"

nsDialogs::Create 1018
Pop $0
${If} $0 == error
Abort
${EndIf}

${NSD_CreateListView} 0u 0u 300u 140u "Listview"
Pop $1
${NSD_LV_InsertColumn} $1 0 200 "column 0"
${NSD_LV_InsertColumn} $1 1 200 "column 1"
${NSD_LV_InsertItem} $1 0 'Item 0'
${NSD_LV_InsertItem} $1 1 'Item 1'
${NSD_LV_InsertItem} $1 2 'Item 2'
; Retrieve the recommended width and height of an icon.
System::Call 'user32::GetSystemMetrics(i${SM_CXICON})i.r7'
System::Call 'user32::GetSystemMetrics(i${SM_CYICON})i.r8'
; Retrieve the handle of shell32.dll.
System::Call 'kernel32::GetModuleHandle(t"shell32.dll")i.r0'
; Load the 9th icon of recommended size in shell32.dll.
System::Call 'user32::LoadImage(i,t,i,i,i,i)i(r0,i9,${IMAGE_ICON},r7,r8,${LR_SHARED})i.R1'
; Free the handle of shell32.dll.
System::Call 'user32::FreeLibrary(ir0)'
; Create an imagelist, width of each image is $7 and height is $8.
System::Call 'comctl32::ImageList_Create(ir7,ir8,i${ILC_MASK}|${ILC_COLOR32},i0,i0)i.R0'
; Add icon to the imagelist by handle.
System::Call 'comctl32::ImageList_AddIcon(iR0,iR1)'
System::Call 'user32::DestroyIcon(iR1)'

SendMessage $1 ${LVM_SETIMAGELIST} ${LVSIL_SMALL} $R0
SendMessage $1 ${LVM_SETEXTENDEDLISTVIEWSTYLE} 0 ${LVS_EX_FULLROWSELECT}

nsDialogs::Show

; Destroy the image list
${NSD_FreeImage} $R1
System::Call 'comctl32::ImageList_Destroy(iR0)'

FunctionEnd

Section -Main

SectionEnd
</highlight-nsis>
Compile the script and run, you will see a page like this:
[[File:Listview2.png]]

FontName plug-in

2010-07-22T03:10:40Z

550771955: /* Description */

{{PageAuthor|Vytautas}}

== Links ==
* <attach>FontName-0.7.zip</attach>
* [[File:Exe.gif]] [http://www.vytux.com/joomla/projects?func=startdown&id=1] (77 KB)

[http://www.vytux.com Vytautas' Website]

== Description ==
'''Version:''' 0.7.

This plugin will retrieve the Display name from a TTF font file. I wrote it to make it easier to register TTF fonts in windows.

Note: This plugin could only get the English name of a font file. If the file contains more localised names, you may want to get the name of current language of your system. More information at: http://nsis.sourceforge.net/Get_localised_font_name.

== How To Use ==
This is an extract from the included readme showing an example of usage:

...

To use the plugin simply include the FontName.nsh file into your script then use one of the following macros:

<highlight-nsis>
!insertmacro FontName "fontfile.ttf"
</highlight-nsis>

Now the stack contains the name of the Font or if the errors flag was set, the error message translated to your current language, or English if the translation is not yet available.

<highlight-nsis>
!insertmacro FontNameVer
</highlight-nsis>

This macro will push to the stack the translated version string for the FontName Plugin.

...

== Notes ==
Please note that the font file MUST exist for the plugin to work, so you should check that before calling the plugin. For a more detailed example of the plugin's usage check out the [[Register Fonts]] and [[Advanced Font Installation]] pages created by me.

Un.installation part for this plug in generate error nd wont work but other things work correct.

== Version History ==
'''[UPDATE: 2005-08-03]'''
Added more translations. The installer now also installs the latest font registration header files.

'''[UPDATE: 2004-02-19]'''
Added french translation to distribution. Optimized source code somewhat.

'''[UPDATE: 2004-02-10]'''
Used a different compiler, reduced the plugin's file size from 32kb to just 9kb.

'''[UPDATE: 2004-01-29]'''
Added an include file so that you need only use the macros provided. Now the plugin is translatable if your language is not included please add it to the list [http://forums.winamp.com/showthread.php?s=&threadid=162550 in this forum.] Changed error reporting prefix to enable better international support.

'''[UPDATE: 2003-11-27]'''
Added error reporting functionality. Check for 'error:' at the start of the returned string on the stack.

'''[UPDATE: 2003-11-26]'''
Fixed plugin crash in Win9x Family.

'''[UPDATE: 2003-11-18]'''
Fixed problem with plugin reporting 'FontFamily' instead of 'FontName' affecting certain fonts, e.g. Arial Bold and Arial were both being reported as Arial.

Vytautas

[[Category:Plugins]]