AddMessage(Region,Int32,String,StorableObject,Boolean,StorableObject,String,Int16) Method

In This Topic

Adds a new message to the project's message management window.

Syntax

C#
C++/CLI

public ProjectMessage AddMessage( 
   IMessage.Region eRegion,
   int nErrNr,
   string strErrTextParam,
   StorableObject oObject1,
   bool bImmediateShow,
   StorableObject oObject2,
   string strAdditionalInfo,
   short nCreationType
)

public:
ProjectMessage^ AddMessage( 
   IMessage.Region eRegion,
   int nErrNr,
   String^ strErrTextParam,
   StorableObject^ oObject1,
   bool bImmediateShow,
   StorableObject^ oObject2,
   String^ strAdditionalInfo,
   short nCreationType
)

Parameters

eRegion: A message of this IMessage.Region is added.
nErrNr: A message with this message number is added.
strErrTextParam: reference to a parameterstring to substitute placeholders in the resource error text. Multiple parameters must be separated with "|". In the error text parameters should be signed by "%1!s!", "%2!s!" etc. If the error text doesn't have any parameter to substitute strErrTextParam must be an empty string
oObject1: The message refers to this object. Optional parameter; can also be NULL.
bImmediateShow: True\: The message is immediately displayed in the message window.
oObject2: A second object to which this message also refers. Optional parameter; can also be NULL.
strAdditionalInfo: Additional language\-independent message text. Is saved as specified in the database. Optional parameter; this string may also be empty.
nCreationType: Additional information about the source of the message. Possible values are: 0 - undefined, 1 - Online verification 2 - Offline verification 3 - Explicit creation Note: In order to add a message with nCreationType = 3, it must be registered and enabled in the message management.

Reference

PrjMessagesCollection Class
PrjMessagesCollection Members
Overload List

Send Feedback