User manual

Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL)
3700S-901-01 Rev. C / July 2008 13-53
channel.getlabel()
Remarks
The parameter ch_list can contain more than one channel. If it does, a comma is
used to delineate the labels for the channels. The return string lists the labels in the
same order that the channels were specified.
The parameter string can contain 'slotX', where X equals 1 to 6, or
'allslots'. It can also contain a label. However, if the label exists, it is in the
returned response and not the numerical channel number. For example, if Channel
1001 has a label of "start", then sending:
print(channel.getlabel('start'))
prints 'start' and not the numeric of '1001'.
An error is generated if:
An empty parameter string is specified.
A specified channel does not exist.
Slot is empty.
Channel not on card.
A channel pattern is specified.
The channel does not support a label setting.
An analog backplane relay is specified.
Command processing stops as soon as an error is detected and a nil response is
then generated. No partial list of labels is returned.
Labels are also supported for digital I/O, DAC, and totalizer channels.
Also see
channel.setlabel() (on page 13-74)
Query commands (on page 13-6)
Example
To query for the label of Channel 1 on Slot 1:
MyLabel = channel.getlabel("1001")
channel.getmatch()
Function
Gets the match value.
Usage
<match_value> = channel.getmatch(<ch_list>)
match_value: Return string listing the comma-delimited states for channels in
ch_list.
ch_list: String specifying digital I/O or totalizer channels to query, using normal
channel list syntax.
Remarks
If a width greater than 1 was specified with the match value, then the value returned
contains the additional channel width specified by the width. For example, the value of
65535 with a width of 2 returns 65535. If the width is 1, then 255 is returned.
DAC, backplane, and switch channels are not supported. If included in a range, they
are ignored; otherwise, an error is generated.
Also see
channel.setmatch() (on page 13-76)