[python source code]

userstring

The userstring commands module.

These commands are used in the following models: DAQ6510, DMM6500, DMM7510, MP5103, SMU2450, SMU2460, SMU2461, SMU2470, SMU2601B, SMU2602B, SMU2604B, SMU2606B, SMU2611B, SMU2612B, SMU2614B, SMU2634B, SMU2635B, SMU2636B, SMU2651A, SMU2657A, SS3706A

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions 
- userstring.add()
- userstring.delete()
- userstring.get()

Userstring

Bases: BaseTSPCmd

The userstring command tree.

Properties and methods
  • .add(): The userstring.add() function.
  • .delete(): The userstring.delete() function.
  • .get(): The userstring.get() function.

add 

add(name: str, value: str) -> None

Run the userstring.add() function.

Description
  • This function adds a user-defined string to nonvolatile memory.
TSP Syntax 
- userstring.add()
Parameters:
  • name (str) –

    The name of the string; the key of the key-value pair.

  • value (str) –

    The string to associate with name; the value of the key-value pair.
Raises:

delete 

delete(name: str) -> None

Run the userstring.delete() function.

Description
  • This function deletes a user-defined string from nonvolatile memory.
TSP Syntax 
- userstring.delete()
Parameters:
  • name (str) –

    The name (key) of the key-value pair of the user-defined string to delete.
Raises:

get 

get(name: str) -> str

Run the userstring.get() function.

Description
  • This function retrieves a user-defined string from nonvolatile memory.
TSP Syntax 
- userstring.get()
Parameters:
  • name (str) –

    The name (key) of the user-defined string.
Returns:
  • str –

    The result of the function call.
Raises: