IsMessageActive
Mon 01 January 2018Syntax
IsMessageActive(Message.Message_Name)
Description
Use the IsMessageActive built-in function to determine whether the specified message definition has been set to inactive in Application Designer.
Note: This function has been deprecated and remains for backward compatibility only. Use the IntBroker class IsOperationActive method instead.
Note: This function is used only with XmlDoc messages, that is, after you get an XmlDoc message (using GetMessageXmlDoc) use this function to determine if the message is active. Use the IsActive message class property to determine if a rowset-based message definition is active.
This function returns True if the message definition for the XmlDoc message is active, False if itâs been inactivated from Application Designer. If you have a lot of PeopleCode associated with publishing an XmlDoc message, you might use this function to check if the message is active before you publish it.
Parameters
|
Field or Control |
Definition |
|---|---|
| Message_Name |
Specify the name of the message you want to inquire about. The message name must be prefixed with the reserved work Message. This function is used only with XmlDoc message definitions. |
Returns
A Boolean value: True if the message is active, False otherwise.