PGCH gate, DETACH_CHANNEL function

The DETACH_CHANNEL function of the PGCH gate is used to detach a channel. The channel may be the current channel, or on the PLCB chain. The channel's containers are only deleted if DELETE(YES) is specified. It is implied that a SET_CURRENT_CHANNEL will be done with this channel at some time.

Input Parameters

CHANNEL_TOKEN
is a token referencing the channel to be used on the initial link.
DELETE
Optional Parameter
whether the channel's containers should be deleted.
Values for the parameter are:
  • NO
  • YES
FREE_SET_STORAGE
Optional Parameter
whether the channel's storage should be freed.
Values for the parameter are:
  • NO
  • YES

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • CHANNEL_NOT_FOUND
The following values are returned when RESPONSE is INVALID:
  • INVALID_LINK_LEVEL
The following values are returned when RESPONSE is INVALID:
  • INVALID_TOKEN
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_PGCHdetach_channel.html | Timestamp icon Last updated: Monday, 5 June 2017