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



Messenger.GetMessageCredentials

Messenger     See also    


Returns authentication credentials sent by the user with the particular message.

Declaration

[C++]
    IPCMessageCredentials* GetMessageCredentials(IPCMessage* Message);

[Pascal]
    function GetMessageCredentials(var Message : TIPCMessage) : TIPCMessageCredentials;

[C#]
    public IPCMessageCredentials GetMessageCredentials(ref IPCMessage Message)

[VB.NET]
    Public Function GetMessageCredentials(ByRef Message As IPCMessage) As IPCMessageCredentials

[Java]
    public IPCMessageCredentials getMessageSource(final IPCMessage message);

[Java ME]
    public synchronized IPCMessageCredentials getMessageSource(final IPCMessage message);

Parameters

  • Message - Reference to the message whose credentials is being queried. See more here

Return value

    Reference to IPCMessageCredentials associated with the message.

Description

    Call this method to get authentication credentials sent with the message. The returned value corresponds to credentials which were passed to OnValidateCredentials. Use this method from message handling code.

    If invalid message reference is passed (eg. the message has been already processed), null/nil/nothing is returned.

    Note: the method doesn't create a new object but returns a reference to existing object. You should not alter or deallocate the returned object and its fields.