User manual

Series 3700 System Switch/Multimeter Reference Manual Section 13: Instrument Control Library (ICL)
3700S-901-01 Rev. C / July 2008 13-75
channel.setlabel()
Remarks
This command sets the label of the specified channel in ch_list to the value
specified in the label parameter. To clear label use the command with the label
parameter equaling an empty string "" or a string with a space as the first character.
If the name specified is being used for an existing channel label, that label reverts to
the default label and the new channel is updated to use the new label if no errors
occur. The previous association with that label is lost. The channel attributes
associated with each channel remain unchanged except for their labels. For example,
channel one on Slot 4 has a label of 'start'. Sending
channel.setlabel('5001', 'start') causes Channel 4001 to lose the
label of 'start' and go back to '4001', while Channel 5001's label is set to
'start'. Using 'start' in commands then refers to 5001 and not 4001.
An error is generated if:
An empty parameter string is specified for ch_list.
Exceeds max length, which is 20 characters.
A specified channel does not exist.
The channel is for an empty slot.
A channel pattern is specified.
The channel does not support a label setting.
An analog backplane relay is specified.
More than one channel is specified in ch_list.
ch_list contains 'slotX' where X = 1 to 6 or 'allslots'.
The label contains a space. However, if the first character is a space, the label is
cleared.
The label is already being used to represent a channel pattern.
Command processing stops as soon as an error is detected and no channel label is
updated. To clear a label back to its factory default, SCCC or SRCC, send an empty
string for the label parameter. The label is not persistent through a power-cycle.
However, a label is part of data saved with a setup.
Labels are also supported for digital I/O, DAC, and totalizer channels.
Details
Not persistent through a power cycle.
You can use labels with commands. Labels and patterns are unique, meaning a
channel label cannot be used for a channel pattern. Whichever one is created or
specified first is the one used. If you try to use one for the other, an error is
generated.
Also see
channel functions and attributes (on page 13-24)