TwclMessageReceiver.Post(TwclMessage,Boolean) Method

Posts the message into the messages queue.

Namespace: wclMessaging
Delphi
public
 function Post(const Message: TwclMessage;
 const Sync: Boolean = False): Integer;

Parameters

Message
Type: TwclMessage

The TwclMessage object represented a message. A caller is responsible to dispose the message object passed into the method.

Sync
Type: Boolean

If the Sync parameter set to True and the thread that called the method is the same that opened the receiver the message will be delivered without putting it into the message queue.

If the thread that posting the message is different from one that opened the receiver or the Sync parameter is False (the default value) the message will be posted into the messages queue.

Return Value

Type: Integer

If the function succeed the return value is wclErrors.WCL_E_SUCCESS. Otherwise the method returns one of the WCL error codes.

The method can be called from any thread.

Note that if sync messages is posted it can be processed before any other messages in the queue.