GUIRegisterMsg - Revision history

Jaberwocky6669 at 16:13, 23 August 2013

2013-08-23T16:13:54Z

← Older revision		Revision as of 16:13, 23 August 2013
Line 1:		Line 1:
	~~==Description==~~		<!-- Autogenerated Wiki Page. -->
	~~Register a~~ user ~~defined function~~ for ~~a known Windows Message ID (WM_MSG)~~.		<!-- Not meant to be user editable. -->
			<!-- If there is an error here then that means that there is an error in the helpfile. -->
			<!-- Report it to Trac with category 'Documentation'. -->
			<!-- See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->
			<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

	<~~pre~~>		<font size='3' weight='normal'>Register a user defined function for a known Windows Message ID (WM_MSG).</font>
	~~GUIRegisterMsg~~ ( ~~msgID, "function"~~ )
	</~~pre~~>

	==Parameters==		<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>
	{\| ~~border='1'~~ class='wikitable'

			:GUIRegisterMsg ( msgID, "function" )


			</div></font>



			===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
			{\| class='wikitable'
	\|-		\|-
	\| msgID \|\| A Windows Message ID (see Appendix: [[Windows Message Codes]]).		\| msgID \|\| A Windows Message ID (see Appendix: [http://www.autoitscript.com/autoit3/docs/appendix/WinMsgCodes.htm Windows Message Codes]).
	\|-		\|-
	\| function \|\| The name of the user function to call when the message appears or an empty string "" to unregister a message.		\| function \|\| The name of the user function to call when the message appears or an empty string "" to unregister a message.
	\|}		\|}

	==Return Value==
	{\|		===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
			{\| class='wikitable'
	\| Success: \|\| 1		\| Success: \|\| 1
	\|-		\|-
Line 21:		Line 34:
	\|}		\|}

	==Remarks==

			===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
	To make the user function workable you have to define it with '''maximum 4 function parameters''' otherwise the function won't be called!		To make the user function workable you have to define it with '''maximum 4 function parameters''' otherwise the function won't be called!

Line 37:		Line 52:
	When the user function is called then these 4 parameters have the following values:		When the user function is called then these 4 parameters have the following values:

	{\| ~~border='1'~~ class='wikitable'		{\| class='wikitable'
	! ~~scope='col'~~ \| '''Position'''		! \| '''Position'''
	! ~~scope='col'~~ \| '''Parameter'''		! \| '''Parameter'''
	! ~~scope='col'~~ \| '''Meaning'''		! \| '''Meaning'''
	\|-		\|-
	\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.		\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.
Line 62:		Line 77:

	'''Warning:''' blocking of running user functions which executes window messages with commands such as "[[MsgBox]]" can lead to unexpected behavior, the return to the system should be as fast as possible!		'''Warning:''' blocking of running user functions which executes window messages with commands such as "[[MsgBox]]" can lead to unexpected behavior, the return to the system should be as fast as possible!


	Some controls consume internally specific Windows Message ID, so registering them will have no effect, e.g; WM_CHAR, WM_KEYDOWN, WM_KEYUP are consumed by an edit control.		Some controls consume internally specific Windows Message ID, so registering them will have no effect, e.g; WM_CHAR, WM_KEYDOWN, WM_KEYUP are consumed by an edit control.

	==Related==

			===<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>===
	[[GUICtrlGetHandle]]		[[GUICtrlGetHandle]]

	==Example==

			===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>===
	<syntaxhighlight lang='autoit'>		<syntaxhighlight lang='autoit'>
	; Create an ownerdrawn/colored button		; Create an ownerdrawn/colored button
Line 449:		Line 469:
	EndFunc ;==>GetWindowLong		EndFunc ;==>GetWindowLong
	</syntaxhighlight>		</syntaxhighlight>
			</font>
	__NOTOC__		__NOTOC__
			__NOEDITSECTION__

Jaberwocky6669 at 14:01, 18 August 2013

2013-08-18T14:01:13Z

← Older revision		Revision as of 14:01, 18 August 2013
Line 8:		Line 8:
	==Parameters==		==Parameters==
	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
			\|-
	\| msgID \|\| A Windows Message ID (see Appendix: [[Windows Message Codes]]).		\| msgID \|\| A Windows Message ID (see Appendix: [[Windows Message Codes]]).

	\|-		\|-
	\| function \|\| The name of the user function to call when the message appears or an empty string "" to unregister a message.		\| function \|\| The name of the user function to call when the message appears or an empty string "" to unregister a message.

	\|}		\|}

	==Return Value==		==Return Value==
	{\|		{\|
	\| Success: \|\| 1		\| Success: \|\| 1
	\|-		\|-
	\| Failure: \|\| 0		\| Failure: \|\| 0
	\|}		\|}

Line 28:		Line 27:
	Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam)		Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam)
	...		...

	EndFunc		EndFunc

Line 35:		Line 33:
	Func MyUserFunction($hWndGUI, $MsgID)		Func MyUserFunction($hWndGUI, $MsgID)
	...		...

	EndFunc		EndFunc

Line 41:		Line 38:

	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	\| ~~<b>~~Position~~</b>~~ \|~~\| <b>~~Parameter~~</b> \|~~\| ~~<b>~~Meaning~~</b>~~		! scope='col' \| '''Position'''
			! scope='col' \| '''Parameter'''
			! scope='col' \| '''Meaning'''
	\|-		\|-
	\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.		\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.
Line 55:		Line 54:

	By default after finishing the user function the AutoIt internal message handler will be proceed.		By default after finishing the user function the AutoIt internal message handler will be proceed.

	That won't be if your '''Return''' a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value.		That won't be if your '''Return''' a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value.

	By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!		By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!

Line 146:		Line 143:
	EndIf		EndIf
	; Proceed the default AutoIt3 internal message commands.		; Proceed the default AutoIt3 internal message commands.

	; You also can complete let the line out.		; You also can complete let the line out.
			;!
	; !!! But only 'Return' (without any value) will not proceed		But only 'Return' (without any value) will not proceed
	; the default AutoIt3-message in the future !!!		; the default AutoIt3-message in the future!

	Return $GUI_RUNDEFMSG		Return $GUI_RUNDEFMSG

Jaberwocky6669 at 09:01, 18 August 2013

2013-08-18T09:01:43Z

← Older revision		Revision as of 09:01, 18 August 2013
Line 9:		Line 9:
	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	\| msgID \|\| A Windows Message ID (see Appendix: [[Windows Message Codes]]).		\| msgID \|\| A Windows Message ID (see Appendix: [[Windows Message Codes]]).

	\|-		\|-
	\| function \|\| The name of the user function to call when the message appears or an empty string "" to unregister a message.		\| function \|\| The name of the user function to call when the message appears or an empty string "" to unregister a message.

	\|}		\|}

	==Return Value==		==Return Value==
	{\|		{\|
	\| Success: \|\| 1		\| Success: \|\| 1
	\|-		\|-
	\| Failure: \|\| 0		\| Failure: \|\| 0
	\|}		\|}

	==Remarks==		==Remarks==
	To make the user function workable you have to define it with '''maximum 4 function parameters''' otherwise the function won't be called!		To make the user function workable you have to define it with '''maximum 4 function parameters''' otherwise the function won't be called!

	i.e:		i.e:
	Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam)		Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam)
	...		...

	EndFunc		EndFunc

Line 31:		Line 35:
	Func MyUserFunction($hWndGUI, $MsgID)		Func MyUserFunction($hWndGUI, $MsgID)
	...		...

	EndFunc		EndFunc

Line 36:		Line 41:

	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	~~! scope='col'~~ \| <b>Position</b>		\| <b>Position</b> \|\| <b>Parameter</b> \|\| <b>Meaning</b>
	~~! scope='col'~~ \| <b>Parameter</b>
	~~! scope='col'~~ \| <b>Meaning</b>
	\|-		\|-
	\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.		\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.
Line 52:		Line 55:

	By default after finishing the user function the AutoIt internal message handler will be proceed.		By default after finishing the user function the AutoIt internal message handler will be proceed.

	That won't be if your '''Return''' a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value.		That won't be if your '''Return''' a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value.

	By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!		By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!

	If you want AutoIt to run its internal handler for a message, return the variable '''$GUI_RUNDEFMSG''' (in GUIConstantsEx.au3) from the function (see also examples)!		If you want AutoIt to run its internal handler for a message, return the variable '''$GUI_RUNDEFMSG''' (in GUIConstantsEx.au3) from the function (see also examples)!

	I.e. if you want to return earlier than the user function ends and also proceed the AutoIt internal message handler.		I.e. if you want to return earlier than the user function ends and also proceed the AutoIt internal message handler.

Line 140:		Line 146:
	EndIf		EndIf
	; Proceed the default AutoIt3 internal message commands.		; Proceed the default AutoIt3 internal message commands.

	; You also can complete let the line out.		; You also can complete let the line out.

	; !!! But only 'Return' (without any value) will not proceed		; !!! But only 'Return' (without any value) will not proceed
	; the default AutoIt3-message in the future !!!		; the default AutoIt3-message in the future !!!

	Return $GUI_RUNDEFMSG		Return $GUI_RUNDEFMSG
	EndFunc ;==>MY_WM_COMMAND		EndFunc ;==>MY_WM_COMMAND

Jaberwocky6669 at 08:31, 18 August 2013

2013-08-18T08:31:07Z

← Older revision		Revision as of 08:31, 18 August 2013
Line 36:		Line 36:

	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	! scope='col' \| ~~'''~~Position~~'''~~		! scope='col' \| <b>Position</b>
	! scope='col' \| ~~'''~~Parameter~~'''~~		! scope='col' \| <b>Parameter</b>
	! scope='col' \| ~~'''~~Meaning~~'''~~		! scope='col' \| <b>Meaning</b>
	\|-		\|-
	\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.		\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.

Jaberwocky6669 at 06:40, 18 August 2013

2013-08-18T06:40:57Z

← Older revision		Revision as of 06:40, 18 August 2013
Line 2:		Line 2:
	Register a user defined function for a known Windows Message ID (WM_MSG).		Register a user defined function for a known Windows Message ID (WM_MSG).

	~~==Syntax==~~		<pre>
	<~~syntaxhighlight lang='autoit'~~>
	GUIRegisterMsg ( msgID, "function" )		GUIRegisterMsg ( msgID, "function" )
	</~~syntaxhighlight~~>		</pre>


	==Parameters==		==Parameters==
	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	\| msgID \|\| A Windows Message ID (see Appendix: [[Windows Message Codes]] .		\| msgID \|\| A Windows Message ID (see Appendix: [[Windows Message Codes]]).
	\|-		\|-
	\| function \|\| The name of the user function to call when the message appears or an empty string "" to unregister a message.		\| function \|\| The name of the user function to call when the message appears or an empty string "" to unregister a message.
	\|-
	\|}		\|}

	==~~ReturnValue~~==		==Return Value==
	{\| ~~border='1' class='wikitable'~~		{\|
	\| Success: \|\| 1		\| Success: \|\| 1
	\|-		\|-
	\| Failure: \|\| 0		\| Failure: \|\| 0
	\|}		\|}


	==Remarks==		==Remarks==
	~~!!!~~ To make the user function workable you have to define it with ~~<strong>~~maximum 4 function parameters~~</strong>~~ otherwise the function won't be called !!!		To make the user function workable you have to define it with '''maximum 4 function parameters''' otherwise the function won't be called!
	i.e:		i.e:
	Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam)		Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam)
Line 40:		Line 36:

	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	\| ~~<b>~~Position~~</b> <b>~~Parameter~~</b> <b>Meaning</b> \|~~\| ~~<b>Parameter</b> <b>~~Meaning~~</b>~~		! scope='col' \| '''Position'''
			! scope='col' \| '''Parameter'''
			! scope='col' \| '''Meaning'''
	\|-		\|-
	\| 1 hWnd ~~The Window handle of the GUI in which the messa~~ \|\| ~~hWnd~~ The Window handle of the GUI in which the message appears.		\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.
	\|-		\|-
	\| 2 Msg ~~The Windows m~~ \|\| ~~Msg~~ The Windows message ID.		\| 2 \|\| Msg \|\| The Windows message ID.
	\|-		\|-
	\| 3 ~~wParam The first message parameter~~ \|\| wParam ~~The first message parameter as hex value.~~		\| 3 \|\| wParam \|\| The first message parameter as hex value.
	\|-
	\| ~~4 lParam~~ The ~~second message parameter \|\| lParam The second~~ message parameter as hex value.
	\|-		\|-
			\| 4 \|\| lParam \|\| The second message parameter as hex value.
	\|}		\|}

Line 55:		Line 52:

	By default after finishing the user function the AutoIt internal message handler will be proceed.		By default after finishing the user function the AutoIt internal message handler will be proceed.
	That won't be if your ~~<strong>~~Return~~</strong>~~ a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value.		That won't be if your '''Return''' a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value.
	By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!		By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!

	~~!!!~~ If you want AutoIt to run its internal handler for a message, return the variable ~~<strong>~~$GUI_RUNDEFMSG~~</strong>~~ (in GUIConstantsEx.au3) from the function (see also examples) !!!		If you want AutoIt to run its internal handler for a message, return the variable '''$GUI_RUNDEFMSG''' (in GUIConstantsEx.au3) from the function (see also examples)!
	I.e. if you want to return earlier than the user function ends and also proceed the AutoIt internal message handler.		I.e. if you want to return earlier than the user function ends and also proceed the AutoIt internal message handler.

	~~<strong>~~Warning:~~</strong>~~ blocking of running user functions which executes window messages with commands such as "[[MsgBox()]] can lead to unexpected behavior, the return to the system should be as fast as possible !!!		'''Warning:''' blocking of running user functions which executes window messages with commands such as "[[MsgBox]]" can lead to unexpected behavior, the return to the system should be as fast as possible!

	Some controls consume internally specific Windows Message ID, so registering them will have no effect, e.g; WM_CHAR, WM_KEYDOWN, WM_KEYUP are consumed by an edit control.		Some controls consume internally specific Windows Message ID, so registering them will have no effect, e.g; WM_CHAR, WM_KEYDOWN, WM_KEYUP are consumed by an edit control.


	==Related==		==Related==
	[[GUICtrlGetHandle]]		[[GUICtrlGetHandle]]



	==Example==		==Example==
Line 450:		Line 444:
	EndFunc ;==>GetWindowLong		EndFunc ;==>GetWindowLong
	</syntaxhighlight>		</syntaxhighlight>

			__NOTOC__

Jaberwocky6669 at 18:30, 15 August 2013

2013-08-15T18:30:50Z

Show changes

Jaberwocky6669: Jaberwocky6669 moved page GUIRegisterMsg to Tutorial GUIRegisterMsg: Moved to make way for a possible help file page.

2013-08-15T18:27:29Z

Jaberwocky6669 moved page GUIRegisterMsg to Tutorial GUIRegisterMsg: Moved to make way for a possible help file page.

New page

#REDIRECT [[Tutorial GUIRegisterMsg]]

← Older revision		Revision as of 08:31, 18 August 2013
Line 36:		Line 36:

	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	! scope='col' \| ~~'''~~Position~~'''~~		! scope='col' \| <b>Position</b>
	! scope='col' \| ~~'''~~Parameter~~'''~~		! scope='col' \| <b>Parameter</b>
	! scope='col' \| ~~'''~~Meaning~~'''~~		! scope='col' \| <b>Meaning</b>
	\|-		\|-
	\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.		\| 1 \|\| hWnd \|\| The Window handle of the GUI in which the message appears.