Programmer Guide/Macro Library/SETMSGHANDLER - Revision history

Jw: /* Examples: */

2019-08-06T07:04:34Z

Examples:

← Older revision		Revision as of 09:04, 6 August 2019
Line 26:		Line 26:
	SETMSGHANDLER VALUE * MH_VALUEITEM		SETMSGHANDLER VALUE * MH_VALUEITEM
	</pre>		</pre>

			==See also==
			[[Programmer_Guide/Macro_Library/GETMESSAGE\|GETMESSAGE]]

Jw: /* SETMSGHANDLER */

2019-08-06T07:03:52Z

SETMSGHANDLER

← Older revision		Revision as of 09:03, 6 August 2019
Line 2:		Line 2:
	==SETMSGHANDLER==		==SETMSGHANDLER==

	Install the message handler <var>handler</var> for the sender(s) defined by <var>type name</var>. If no handler is supplied, the message handler is deinstalled. If a message handler is installed for <var>type name</var>, the macro <code>[[Programmer_Guide/Macro_Library/~~StdLib#GetMessage~~\|GETMESSAGE]]</code> calls the handler function when receiving messages of <var>type name</var>. This means the messages are not returned (except if the keyword <code>RETURN</code> was used as a handler argument). A message handler function receives the whole message (<code>type name id par</code>) as an argument string.		Install the message handler <var>handler</var> for the sender(s) defined by <var>type name</var>. If no handler is supplied, the message handler is deinstalled. If a message handler is installed for <var>type name</var>, the macro <code>[[Programmer_Guide/Macro_Library/GETMESSAGE\|GETMESSAGE]]</code> calls the handler function when receiving messages of <var>type name</var>. This means the messages are not returned (except if the keyword <code>RETURN</code> was used as a handler argument). A message handler function receives the whole message (<code>type name id par</code>) as an argument string.

	The message dispatching system is only active while the macro <code>GETMESSAGE</code> is running!		The message dispatching system is only active while the macro <code>GETMESSAGE</code> is running!

Jw: /* Parameters: */

2019-06-14T09:43:13Z

Parameters:

← Older revision		Revision as of 11:43, 14 June 2019
Line 13:		Line 13:

	;type:The item type of sender; any shell item type (sending messages) or <code>SHELL</code>		;type:The item type of sender; any shell item type (sending messages) or <code>SHELL</code>
	;name:The name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.~~handlerThe~~ message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.		;name:The name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.
			;handler:The message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.

	=====Result:=====		=====Result:=====

Jw: /* Parameters: */

2019-06-14T09:42:52Z

Parameters:

← Older revision		Revision as of 11:42, 14 June 2019
Line 12:		Line 12:
	=====Parameters:=====		=====Parameters:=====

	;type:The item type of sender; any shell item type (sending messages) or <code>SHELL</code>~~nameThe~~ name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.handlerThe message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.		;type:The item type of sender; any shell item type (sending messages) or <code>SHELL</code>
			;name:The name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.handlerThe message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.

	=====Result:=====		=====Result:=====

Jw: /* Parameters: */

2019-06-14T09:42:37Z

Parameters:

← Older revision		Revision as of 11:42, 14 June 2019
Line 12:		Line 12:
	=====Parameters:=====		=====Parameters:=====

	~~typeThe~~ item type of sender; any shell item type (sending messages) or <code>SHELL</code>nameThe name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.handlerThe message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.		;type:The item type of sender; any shell item type (sending messages) or <code>SHELL</code>nameThe name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.handlerThe message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.

	=====Result:=====		=====Result:=====

Jw at 07:46, 23 February 2018

2018-02-23T07:46:36Z

← Older revision		Revision as of 09:46, 23 February 2018
Line 2:		Line 2:
	==SETMSGHANDLER==		==SETMSGHANDLER==

	Install the message handler <var>handler</var> for the sender(s) defined by <var>type name</var>. If no handler is supplied, the message handler is deinstalled. If a message handler is installed for <var>type name</var>, the macro <code>GETMESSAGE</code> calls the handler function when receiving messages of <var>type name</var>. This means the messages are not returned (except if the keyword <code>RETURN</code> was used as a handler argument). A message handler function receives the whole message (<code>type name id par</code>) as an argument string.		Install the message handler <var>handler</var> for the sender(s) defined by <var>type name</var>. If no handler is supplied, the message handler is deinstalled. If a message handler is installed for <var>type name</var>, the macro <code>[[Programmer_Guide/Macro_Library/StdLib#GetMessage\|GETMESSAGE]]</code> calls the handler function when receiving messages of <var>type name</var>. This means the messages are not returned (except if the keyword <code>RETURN</code> was used as a handler argument). A message handler function receives the whole message (<code>type name id par</code>) as an argument string.

	The message dispatching system is only active while the macro <code>GETMESSAGE</code> is running!		The message dispatching system is only active while the macro <code>GETMESSAGE</code> is running!

Jw at 07:43, 23 February 2018

2018-02-23T07:43:18Z

← Older revision		Revision as of 09:43, 23 February 2018
Line 12:		Line 12:
	=====Parameters:=====		=====Parameters:=====

	typeThe item type of sender; any shell item type (sending messages) or <code>SHELL</code>nameThe name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.handlerThe message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.=====Result:=====		typeThe item type of sender; any shell item type (sending messages) or <code>SHELL</code>nameThe name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.handlerThe message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.

			=====Result:=====

	void		void

Admin: 1 revision: Initial import

2010-11-18T16:31:26Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==SETMSGHANDLER==

Install the message handler <var>handler</var> for the sender(s) defined by <var>type name</var>. If no handler is supplied, the message handler is deinstalled. If a message handler is installed for <var>type name</var>, the macro <code>GETMESSAGE</code> calls the handler function when receiving messages of <var>type name</var>. This means the messages are not returned (except if the keyword <code>RETURN</code> was used as a handler argument). A message handler function receives the whole message (<code>type name id par</code>) as an argument string.

The message dispatching system is only active while the macro <code>GETMESSAGE</code> is running!

=====Usage:=====

<code>SETMSGHANDLER <var>type</var> <var>name</var> [<var>handler</var>]</code>

=====Parameters:=====

typeThe item type of sender; any shell item type (sending messages) or <code>SHELL</code>nameThe name of the sender; shell item name, shell id or <code>*</code> for all items of the specified type <var>type</var>.handlerThe message handler function. This function will be called when a message for an item corresponding to <var>type</var> and <var>name</var> is received. If <var>handler</var> is not supplied, any previously installed message handler for <var>type name</var> is removed. The handler function can be either a macro (<var>handler</var> = macroname) or a class member-function (<var>handler</var> = memberfunction instance). The following keywords are also supported: <code>IGNORE</code> (all messages for <var>type</var> <var>name</var> are ignored) and <code>RETURN</code> (return from <code>GETMESSAGE</code> if a message for <var>type</var> <var>name</var> is received). If the <var>type</var> is <code>SPU</code>,the following keywords are also supported: <code>KILLSPUONSTOP</code> (the SPU is deleted when the <code>STOP</code> message is received) and <code>KILLSPUONEXIT</code> (the SPU is deleted when the <code>EXIT</code> message is received). The message handler function receives the whole message (<code>type name id par</code>) as an argument string.=====Result:=====

void

=====Examples:=====

<pre>
// Any messages for value items are passed to the macro MH_VALUEITEM.
SETMSGHANDLER VALUE * MH_VALUEITEM
</pre>