- Contents
DesignerCOM API
II3IDMessages::Add Method
Synopsis
Adds a message to the Interaction Designer messages collection.
IDL Function Prototype
HRESULT Add(
[in] long MessageNumber,
[in, optional] long MessageSeverity,
[in, optional] BSTR MessageDescription,
[in, optional] BSTR MessageSource,
[in, optional] BSTR Topic,
[in, optional] IDispatch * MessageContext,
[in, optional, defaultvalue(0)] VAIANT_BOOL PersistMessage,
[in, optional, defaultvalue(0)] I3IDMessageType MessageType,
[in, optional, defaultvalue(0)] I3IDMessageCategory MessageCategory,
[in, optional] BSTR MessageHelpURL,
[in, optional] BSTR MessageHelpFile,
[in, optional] long Messa
C/C++ Syntax
HRESULT Add(long MessageNumber, long MessageSeverity, BSTR MessageDescription, BSTR MessageSource, BSTR Topic, Dispatch * MessageContext, VAIANT_BOOL PersistMessage, I3IDMessageType MessageType, I3IDMessageCategory MessageCategory, BSTR MessageHelpURL, BSTR MessageHelpFile, long Messa
Parameters
- MessageNumber
-
The message number.
- MessageSeverity
-
A number that represents the severity of this message.
- MessageDescription
-
Description of information for this message.
- MessageSource
-
Source of this message.
- Topic
-
The topic of this message.
- MessageContext
-
MessageContext is an optional input parameter of type IDispatch.
- PersistMessage
-
This optional parameter is a Boolean that indicates whether or not this message should be persisted with the handler. It only applies to messages that have handler/step context. Specify True if the message should be persisted with the handler; otherwise False.
- MessageType
-
An I3IDMessageType value
- MessageCategory
-
An I3IDMessageCategory value.
- MessageHelpURL
-
Optional URL pointing to more information about this message.
- MessageHelpFile
-
Optional name of the Windows Help file contains information about this message.
- MessageHelpFileContext
-
The optional context ID number of a Windows help file topic that corresponds to this message.
- NewMessage
-
The return value is an II3IDMessage message object.