IVCMessageObserver Class Reference

Inheritance diagram for IVCMessageObserver:

IBase


Public Methods

virtual oa::oaUInt4 onMessageOut (IDMObject *object, oa::oaUInt4 operation, oa::oaUInt4 msgType, const char *text)=0

Detailed Description

This interface is implemented by a client of the version control (VC) system to receive callback messages resulting from VC operations.


Member Function Documentation

oa::oaUInt4 IVCMessageObserver::onMessageOut IDMObject *    object,
oa::oaUInt4    operation,
oa::oaUInt4    msgType,
const char *    text
[pure virtual]
 

This function is implemented by clients of the VC system. It is called by the VC plug-in when a textual message needs to be transmitted to the client (and usually to the end user).

Parameters:
object This is a pointer to the IDMObject interface of the object that is being operated on.
operation This parameter holds a value that indicates the operation that is in effect when this message generated. The possible values of this parameter are given in oaVCOperationEnum.
msgType This is the type of message that is being sent to the client. Possible values are given in oaVCMessageTypeEnum. The oacVCMsgTypeQueryOk value is used by the Plug-in to request feedback from the client (which will typically pass the request to the end user). If this value is used for the message type, then the return value of onMessageOut is checked. It should be one of the values in oaVCObserverResultEnum - this return value indicates the decision of the client on the disposition of the impending action. This usually happens when the VC system finds it needs to perform some destructive action resulting from the requested operation and wants verification that this action is correct.
text This is the actual text of the message, in a null terminated character array.


The documentation for this class was generated from the following files:

Return to top of page