wclMessageReceiverPost Method |
Places a message to the messages queue and starts processing
the messages.
Namespace: wclCommonAssembly: wclCommon (in wclCommon.dll) Version: 7.13.6.0 (7.13.6.0)
Syntaxpublic int Post(
wclMessage Message,
bool Sync = false
)
Public Function Post (
Message As wclMessage,
Optional Sync As Boolean = false
) As Integer
public:
int Post(
wclMessage^ Message,
bool Sync = false
)
Parameters
- Message wclMessage
- The wclMessage object. A caller
is responsible to dispose the message object passed into the
method.
- Sync Boolean (Optional)
If the Sync parameter is True
and the thread that called the method is the same that used to call
the Open method the message will be delivered without placing
it to the messages queue.
If the thread that posting the message is different from one
that was used to call the Open method or the Sync
parameter is False (the default value) the message will be
placed to the messages queue.
Return Value
Int32 If the function succeed the return value is
WCL_E_SUCCESS. Otherwise the method returns one of
the WCL error codes.
Remarks If sync messages is posted it can be processed before any
other messages in the queue.
See Also