Discuss this help topic in MsgConnect Forum

Filter: C++  Pascal  C#  VB.NET  Java  Java ME  ActiveX  DLL 



Messenger.ForwardMessage

Messenger     See also    


Forwards a message to another recipient.

Declaration

[C++]
    bool ForwardMessage(char* Destination, MCMessage* Message, unsigned long Timeout, MCMessageCredentials* Credentials);

[Pascal]
    function ForwardMessage(Destination : string; var Message : TMCMessage; Timeout : DWORD; Credentials : PMCMessageCredentials) : boolean;

[VB6]
    Function IMCXMessenger3.ForwardMessage(Destination As String, Message As IMCXMessage, Timeout As Long, Credentials As MCXMessageCredentials) As Boolean

[ActiveX]
    HRESULT _stdcall IMCXInetTransport3.ForwardMessage( [in] BSTR Destination, [in, out] IMCXMessage ** Message, [in] unsigned long Timeout, [in] IMCXMessageCredentials * Credentials, [out, retval] VARIANT_BOOL * res);

[C#]
    public boolean ForwardMessage(String Destination, MCMessage Message, int Timeout, MCMessageCredentials Credentials);

[VB.NET]
    Public Function ForwardMessage(ByVal Destination As String, ByRef Message As MCMessage, ByVal Timeout As Integer, ByVal Credentials As MCMessageCredentials) As Boolean

[Java]
    public boolean ForwardMessage(String destination, MCMessage message, long timeout, MCMessageCredentials credentials);

[Java ME]
    public synchronized boolean ForwardMessage(String destination, MCMessage message, long timeout, MCMessageCredentials credentials);

[DLL]
    long __stdcall MCMessengerForwardMessage(HMCMessenger h, char* Destination, MCMessage* Message, unsigned long Timeout, MCMessageCredentials* Credentials, long* res);

Parameters

  • [DLL]h - handle to the Messenger object that was returned by Create method

  • Destination - The address of the message recipient. See more here
  • Message - The message to be sent. See more here
  • Timeout - Time after which the method discards the message (see description). Setting this parameter to 0xFFFFFFFF ($FFFFFFFF) causes the method to wait infinitely.
  • Credentials - (optional) Credentials to be set for the message. Can be set to null (nil) if credentials system is not used. See more here

Description

    Call this method to forward the received message to another destination. After the message is replied (if needed), the reply will be transferred to the sender of original message via the messenger, that called ForwardMessage. After ForwardMessage is called, it is not recommended to change any message parameters.
If timeout expires and the reply is not received, the message is removed from the waiting list and, if the reply is received after timeout expiration, it will be discarded. For information about error and timeout handling see Error and Timeout Handling topic.

Discuss this help topic in MsgConnect Forum