SetStatus method: IntBroker class

Syntax

SetStatus(&Message, Status)

Description

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

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:

  • Canceled

  • Done

  • Error

  • New

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

  • Canceled

  • Done

  • Error

  • New

Parameters

Parameter Description

&Message

Specify an already instantiated message object that you want to set the status for.

Status

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

Constant Value Description

%Operation_Canceled

Cancel the message.

%Operation_Done

Set the message to done.

%Operation_Error

Set the message to be in error.

%Operation_New

Specify the message as new.

Returns

None.