Welcome to the Harris Geospatial documentation center. Here you will find reference guides and help documents.


  >  Docs Center  >  ENVI API  >  Application Control  >  ENVIMessageHandler::OnMessage

ENVIMessageHandler::OnMessage

ENVIMessageHandler::OnMessage

The ENVIBroadcastChannel calls this method to forward messages to all of its subscribers.

Syntax


In most cases, the OnMessage method should only be called by ENVIBroadcastChannel::Broadcast. When called explicitly, the syntax is as follows:

Obj -> [ENVIMessageHandler::]OnMessage, Message

Arguments


Message

The message can be any data type or object. For example, the ENVI user interface subscribes to the broadcast channel to handle message of type ENVIStartMessage, ENVIProgressMessage, and ENVIFinishMessage. Any other type of submission is ignored.

Routine Signature


Implement the method with the following signature:

PRO class::OnMessage, Message

Version History


ENVI 5.3

Introduced

API Version


3.3

See Also


ENVIMessageHandler, ENVIBroadcastChannel



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us