peoplecodeapi - SetChannelStatus

Syntax

SetChannelStatus(ChannelName, Status)

Description

Use the SetChannelStatus to set the status of the specified channel. You could use this function to restart a channel that had been paused, or pause a running channel.

Note: This function has been deprecated and remains for backward compatibility only. Use the IntBroker class SetQueueStatus method instead.

Parameters

Field or Control	Definition
`ChannelName`	Specify the channel name.
`Status`	Specify the status you want to set the channel to. The values are: 1 for Run 2 for Pause

Field or Control

Definition

ChannelName

Specify the channel name.

Status

Specify the status you want to set the channel to. The values are:

1 for Run
2 for Pause

Returns

A Boolean value: True if the channel status was changed successfully. False otherwise.