Programmer Guide/Macro Library/GETMESSAGE - Revision history

Jw: /* GETMESSAGE */

2019-06-14T11:36:03Z

GETMESSAGE

← Older revision		Revision as of 13:36, 14 June 2019
Line 4:		Line 4:
	This macro retrieves and dispatches messages. If a message handler is installed, the message is forwarded to the handler to perform message processing.		This macro retrieves and dispatches messages. If a message handler is installed, the message is forwarded to the handler to perform message processing.

	The argument "queued" controls the processing of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue should be disabled in (sub-) message loops which queue (unknown) messages by calling the macro <code>[[Programmer Guide/Macro Library/MSGQUEUE\|MSGQUEUE]]</code>.		The argument <var>queued</var> controls the processing of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue should be disabled in (sub-) message loops which queue (unknown) messages by calling the macro <code>[[Programmer Guide/Macro Library/MSGQUEUE\|MSGQUEUE]]</code>.

	If the argument "forever" equals 0, all messages which were not processed by a handler, are returned. If "forever" equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code><1). Most applications uses the call "getmessage 1 1" to implement the main message loop.		If the argument <var>forever</var> equals 0, all messages which were not processed by a handler, are returned. If <var>forever</var> equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code><1). Most applications uses the call <code>getmessage 1 1</code> to implement the main message loop.

	The argument "nodispatch" can be set to 1 to disable message handlers. In this case all messages are returned and must be ~~precessed~~ by the caller.		The argument <var>nodispatch</var> can be set to 1 to disable message handlers. In this case all messages are returned and must be processed by the caller.

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

Jw: /* GETMESSAGE */

2019-06-14T11:07:49Z

GETMESSAGE

← Older revision		Revision as of 13:07, 14 June 2019
Line 4:		Line 4:
	This macro retrieves and dispatches messages. If a message handler is installed, the message is forwarded to the handler to perform message processing.		This macro retrieves and dispatches messages. If a message handler is installed, the message is forwarded to the handler to perform message processing.

	The argument "queued" controls the processing of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue should be disabled in (sub-) message loops which ~~queues~~ (unknown) messages by calling the macro <code>[[Programmer Guide/Macro Library/MSGQUEUE\|MSGQUEUE]]</code>.		The argument "queued" controls the processing of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue should be disabled in (sub-) message loops which queue (unknown) messages by calling the macro <code>[[Programmer Guide/Macro Library/MSGQUEUE\|MSGQUEUE]]</code>.

	If the argument "forever" equals 0, all messages which were not processed by a handler, are returned. If "forever" equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code><1). Most applications uses the call "getmessage 1 1" to implement the main message loop.		If the argument "forever" equals 0, all messages which were not processed by a handler, are returned. If "forever" equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code><1). Most applications uses the call "getmessage 1 1" to implement the main message loop.

Jw: /* GETMESSAGE */

2019-06-14T11:07:17Z

GETMESSAGE

← Older revision		Revision as of 13:07, 14 June 2019
Line 3:		Line 3:

	This macro retrieves and dispatches messages. If a message handler is installed, the message is forwarded to the handler to perform message processing.		This macro retrieves and dispatches messages. If a message handler is installed, the message is forwarded to the handler to perform message processing.

			The argument "queued" controls the processing of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue should be disabled in (sub-) message loops which queues (unknown) messages by calling the macro <code>[[Programmer Guide/Macro Library/MSGQUEUE\|MSGQUEUE]]</code>.

	If the argument "forever" equals 0, all messages which were not processed by a handler, are returned. If "forever" equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code><1). Most applications uses the call "getmessage 1 1" to implement the main message loop.		If the argument "forever" equals 0, all messages which were not processed by a handler, are returned. If "forever" equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code><1). Most applications uses the call "getmessage 1 1" to implement the main message loop.

	The argument "queued" controls the processing of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue should be disabled in (sub-) message loops which queues (unknown) messages by calling the macro <code>[[Programmer Guide/Macro Library/MSGQUEUE\|MSGQUEUE]]</code>.

	The argument "nodispatch" can be set to 1 to disable message handlers. In this case all messages are returned and must be precessed by the caller.		The argument "nodispatch" can be set to 1 to disable message handlers. In this case all messages are returned and must be precessed by the caller.

Jw: /* Notes: */

2019-06-14T09:41:31Z

Notes:

← Older revision		Revision as of 11:41, 14 June 2019
Line 46:		Line 46:

	<code>PostMessage</code>		<code>PostMessage</code>

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

Jw: correcting typo

2019-06-14T09:29:47Z

correcting typo

← Older revision		Revision as of 11:29, 14 June 2019
Line 12:		Line 12:
	=====Usage:=====		=====Usage:=====

	<code>GETMESSAGE [ <var>queued</var> <var>forever</var> <var>~~nodispath~~</var> ]</code>		<code>GETMESSAGE [ <var>queued</var> <var>forever</var> <var>nodispatch</var> ]</code>

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

Jw: /* Result: */

2019-06-14T07:18:04Z

Result:

← Older revision		Revision as of 09:18, 14 June 2019
Line 30:		Line 30:
	=====Result:=====		=====Result:=====

	The first not processed message ("<code>type name id par</code>") or "<code>* * * *</code>" if application is finished		The shell variable <code>RESULT</code> is set to the first not processed message ("<code>type name id par</code>") or "<code>* * * *</code>" if application is finished

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

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}}}}
==GETMESSAGE==

This macro retrieves and dispatches messages. If a message handler is installed, the message is forwarded to the handler to perform message processing.

If the argument "forever" equals 0, all messages which were not processed by a handler, are returned. If "forever" equals 1, all not processed messages are ignored and <code>GETMESSAGE</code> stays active until the application is finished (variable <code>APPMODE</code><1). Most applications uses the call "getmessage 1 1" to implement the main message loop.

The argument "queued" controls the processing of messages stored in the secondary queue. This queue is filled with messages which can not be processed at the time. The processing of the secondary queue should be disabled in (sub-) message loops which queues (unknown) messages by calling the macro <code>[[Programmer Guide/Macro Library/MSGQUEUE|MSGQUEUE]]</code>.

The argument "nodispatch" can be set to 1 to disable message handlers. In this case all messages are returned and must be precessed by the caller.

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

<code>GETMESSAGE [ <var>queued</var> <var>forever</var> <var>nodispath</var> ]</code>

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

;<var>queued</var>

:Process messages from secondary queue (0=no, 1=yes; def.=1)

;<var>forever</var>

:Run while application is active, do not return not-processed (0=no, 1=yes; def.=0)

;<var>nodispatch</var>

:Disable message dispatching, return all messages (0=no, 1=yes; def.=0)

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

The first not processed message ("<code>type name id par</code>") or "<code>* * * *</code>" if application is finished

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

Define a message handler and then process messages until the application is closed.

<pre>
setmsghandler * * mh
do while $AppMode != 0
getmessage
end
setmsghandler * *
</pre>
=====Notes:=====

<code>PostMessage</code>