Skip to content

← programming package

ReadEnvironmentVariable

Reads in an environment variable from the system.

If the variable exists, its value is passed out as a string, which can be wired into another node's property. For example it could be used with the StringFormat node to create a filename passed into RecordToXDF. If the environment variable is not found, a warning is printed but no error is raised, and the default value is passed instead. Version 1.0.0

Ports/Properties

result

Value of the environment variable

verbose name
Result
default value
None
port type
DataPort
value type
str (can be None)
data direction
OUT

name

Name of the environment variable to load.

verbose name
Name
default value
None
port type
StringPort
value type
str (can be None)

default

Default value output in the event the environment variable is unspecified or is not found.

verbose name
Default
default value
port type
Port
value type
object (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)