User manual

Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL)
3700S-901-01 Rev. C / July 2008 13-51
channel.getforbidden()
Remarks
The ch_list parameter indicates the scope of channels to check and may include:
'allslots' or 'slotX' (where X equals 1 to 6).
Channel ranges or individual channels.
Analog backplane relays.
Channel pattern(s).
If there are no channels in the scope of the channel list that are on the forbidden list,
the string returned will be empty or nil. The format of the channels will be SCCC or
SRCC in the response string.
Also see
channel.clearforbidden() (on page 13-36)
channel.setforbidden() (on page 13-73)
Example
To query for the channels that are "forbidden to close" channels in the system:
MyForbidden = channel.getforbidden('allslots')
To query for channels only on slot3:
MyForbidden = channel.getforbidden('slot3')
To query for channels in specified list:
MyForbidden =
channel.getforbidden('1911:1916,2004,2008,2012')
channel.getimage()
Function
Query a channel for items associated with that channel when used with a switching
aspect command.
Usage
channels = channel.getimage(<ch_list>)
ch_list: A string representing the channels to query.
channels: A string listing the channels and analog backplane relays associated with
the specified item(s).
Remarks
An error is generated if:
A channel pattern is specified
The specified channel is invalid.
Channel does not exist on the specified slot.
An empty parameter string is specified.
The parameter string can contain 'slotX', where X equals 1 to 6, or
'allslots'.
The returned string lists the channels in the SCCC or SRCC format. A request for
multiple channels is delimited by a semicolon. However, commas delineate the
specific channels and analog backplane relays for an individual channel in the string.
If an error is detected or the slot is empty, the response is nil.
For digital I/O, DAC, and totalizer channels, the channel number itself is returned with
no backplanes, pairings, and so on.