OnSendingMessage Method (messageType, info, message)

[This is preliminary documentation and is subject to change.]

Called when a message is about to be sent by the framework. An agent can implement this method to filter outbound messages in order to change the message content or prevent the framework from sending a message to the server. When filtering messages, return

CopyC#

true

to allow the framework to send this message or

CopyC#

false

to silently discard the message.

Declaration Syntax

Visual Basic

Visual C++

bool OnSendingMessage(
	SifMessageType messageType,
	IMessageInfo info,
	StringBuilder message
)

Function OnSendingMessage ( _
	messageType As SifMessageType, _
	info As IMessageInfo, _
	message As StringBuilder _
) As Boolean

bool OnSendingMessage (
	SifMessageType messageType, 
	IMessageInfo^ info, 
	StringBuilder^ message
)

Parameters

messageType (SifMessageType)

A message type constant (e.g.

CopyC#

SIFMessagingListener.SIF_EVENT

)

info (IMessageInfo)

The MessageInfo instance associated with the message

message (StringBuilder)

A StringBuffer containing the message to be sent. The contents of the buffer may be modified by this method.

Assembly: Edustructures.SifWorks.Adk (Module: Edustructures.SifWorks.Adk) Version: 2.0.0.10