Reading Message Table resources from DLL files - Revision history

Kichik: Reverted edits by 221.11.27.110 to last version by CancerFace

2008-12-04T22:29:17Z

Reverted edits by 221.11.27.110 to last version by CancerFace

â† Older revision		Revision as of 22:29, 4 December 2008
Line 2:		Line 2:
	NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=246116 thread]		NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=246116 thread]

	~~lileto~~		== Description ==
			DLL files can contain Message Table resources with various strings that may be useful. How can these strings be extracted and used from within an NSIS installer? What if those strings are localized and contain unicode text? Using the [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/formatmessage.asp FormatMessage] API call one can get strings out of DLL files and use them directly

	== Usage ==		== Usage ==

221.11.27.110: acoueltri

2008-12-04T22:24:29Z

acoueltri

â† Older revision		Revision as of 22:24, 4 December 2008
Line 2:		Line 2:
	NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=246116 thread]		NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=246116 thread]

	~~== Description ==~~		lileto
	DLL files can contain Message Table resources with various strings that may be useful. How can these strings be extracted and used from within an NSIS installer? What if those strings are localized and contain unicode text? Using the [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/formatmessage.asp FormatMessage] API call one can get strings out of DLL files and use them directly

	== Usage ==		== Usage ==

CancerFace at 09:59, 8 June 2006

2006-06-08T09:59:20Z

â† Older revision		Revision as of 09:59, 8 June 2006
Line 66:		Line 66:
	* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/formatmessage.asp FormatMessage]		* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/formatmessage.asp FormatMessage]
	* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/freelibrary.asp FreeLibrary]		* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/freelibrary.asp FreeLibrary]

			[[Category:Code Examples]]

CancerFace at 20:03, 2 June 2006

2006-06-02T20:03:04Z

â† Older revision		Revision as of 20:03, 2 June 2006
Line 52:		Line 52:
	</highlight-nsis>		</highlight-nsis>
	Now ${BUFFER_VAR} will be a pointer to an address containing the wide string. This address can be directly passed to other APIs without exporting the string to an NSIS variable.		Now ${BUFFER_VAR} will be a pointer to an address containing the wide string. This address can be directly passed to other APIs without exporting the string to an NSIS variable.

			== Notes ==
			* The FormatMessage function used in the above macros exports to $R3 the size of the string that has been read from the library expressed as TCHARS.
			* If the ${FORMAT_MESSAGE_ALLOCATE_BUFFER} parameter is not used when calling the FormatMessage API, the user should provide the size of the buffer to be allocated (6th parameter of the FormatMessage call) in TCHARS.

	== Resources and Links ==		== Resources and Links ==

CancerFace at 19:56, 2 June 2006

2006-06-02T19:56:31Z

New page

{{PageAuthor|CancerFace}}
NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=246116 thread]

== Description ==
DLL files can contain Message Table resources with various strings that may be useful. How can these strings be extracted and used from within an NSIS installer? What if those strings are localized and contain unicode text? Using the [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/formatmessage.asp FormatMessage] API call one can get strings out of DLL files and use them directly

== Usage ==
Call the macro from within your script passing the full path and name of the DLL file containing the Message Table, the ID of the string to get out as well as a variable that will accept the output:
<highlight-nsis>
Var "StringFromDLL"
!insertmacro ReadStringFromDLL "<path_to_dll>\<filename.dll>" <String_ID> $StringFromDLL
</highlight-nsis>

== Macro ==
If you want to get the string into a variable use the following macro:
<highlight-nsis>
!define FORMAT_MESSAGE_ALLOCATE_BUFFER 0x00000100
!define FORMAT_MESSAGE_IGNORE_INSERTS 0x00000200
!define FORMAT_MESSAGE_FROM_HMODULE 0x00000800
!define FORMAT_MESSAGE_MAX_WIDTH_MASK 0x000000FF

!macro ReadStringFromDLL LIBRARY STRING_ID VAR
System::Call 'kernel32::GetSystemDefaultLangID(i v)i .R0'
System::Call 'kernel32::LoadLibraryExW(w "${LIBRARY}", i n, i 2) i .R1'
StrCpy $0 ${FORMAT_MESSAGE_FROM_HMODULE}
IntOp $0 $0 + ${FORMAT_MESSAGE_ALLOCATE_BUFFER}
IntOp $0 $0 + ${FORMAT_MESSAGE_IGNORE_INSERTS}
IntOp $0 $0 + ${FORMAT_MESSAGE_MAX_WIDTH_MASK}
System::Call 'kernel32::FormatMessageW(i r0, i R1, i ${STRING_ID}, i R0, *w .R2, i 0, i n) i .R3'
System::Call 'kernel32::FreeLibrary(i R1)i .R8'
StrCpy ${VAR} $R2
!macroend
</highlight-nsis>

If you want to get the string into a buffer and use it directly from the buffer in order to avoid placing unicode characters into an NSIS variable use the following macro:
<highlight-nsis>
!define FORMAT_MESSAGE_IGNORE_INSERTS 0x00000200
!define FORMAT_MESSAGE_FROM_HMODULE 0x00000800
!define FORMAT_MESSAGE_MAX_WIDTH_MASK 0x000000FF

!macro ReadStringFromDLL LIBRARY STRING_ID BUFFER_VAR
System::Call 'kernel32::GetSystemDefaultLangID(i v)i .R0'
System::Call 'kernel32::LoadLibraryExW(w "${LIBRARY}", i n, i 2) i .R1'
StrCpy $0 ${FORMAT_MESSAGE_FROM_HMODULE}
IntOp $0 $0 + ${FORMAT_MESSAGE_IGNORE_INSERTS}
IntOp $0 $0 + ${FORMAT_MESSAGE_MAX_WIDTH_MASK}
System::Call '*(&w${NSIS_MAX_STRLEN})i.R2'
System::Call 'kernel32::FormatMessageW(i r0, i R1, i ${STRING_ID}, i R0, i R2, i ${NSIS_MAX_STRLEN}, i n) i .R3'
System::Call 'kernel32::FreeLibrary(i R1)i .R8'
StrCpy ${BUFFER_VAR} $R2
!macroend
</highlight-nsis>
Now ${BUFFER_VAR} will be a pointer to an address containing the wide string. This address can be directly passed to other APIs without exporting the string to an NSIS variable.

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=246116 thread]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/intl/nls_4ppg.asp GetSystemDefaultLangID]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/loadlibraryex.asp LoadLibraryEx]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/formatmessage.asp FormatMessage]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/freelibrary.asp FreeLibrary]