win32.base.messages.GetAPMessage

GetAPMessage is available since version 1.0.

Prototype:

number GetAPMessage(var number SenderAPID, var number nMSG_ID, var string szData)

Parameters

SenderAPID
[out] the APID of the sender of the message
nMSG_ID
[out] the number part of a message
szData
[out] the string part of the message

Description:

Waits for an inter-application message, and gets its content. For sending messages, check SendAPMessage. You can check if there is a message waiting to be read, using PeekAPMessage to avoid a blocking call. Also get_message will intercept application messages, besides remote client messages.

Return value:

Returns the size in bytes of the message. If 0, then an error was encountered.