SetStatus method: Message class

Syntax

SetStatus(Status)

Description

Use the SetStatus method to set the status of a publication or subscription contract, much the same way you do in the message monitor.

Note:

This method has been desupported and remains for backward compatibility only. Use the IntBroker class SetStatus method instead.

You may want to use this method after an end-user has finished fixing any errors in the message data.

You can set the status of a contract to one of the following statuses:

  • Cancel

  • Done

  • Error

  • New

The method is available only when the message instance has one of the following statuses:

  • Cancel

  • Done

  • Error

  • New

Parameters

Parameter Description

Status

Specify the status that you want to set the message to. Value are:

  • %Message_Error

  • %Message_New

  • %Message_Done

  • %Message_Started

  • %Message_Working

  • %Message_Retry

  • %Message_Timeout

  • %Message_Edited

  • %Message_Canceled

Returns

None.

Related Topics