Operator Reference

HALCON Operator Reference / Tuple / String Operations
ClassesClasses | | Operators

tuple_environmenttuple_environmentTupleEnvironmentTupleEnvironmenttuple_environment (Operator)

tuple_environmenttuple_environmentTupleEnvironmentTupleEnvironmenttuple_environment — Read one or more environment variables.

Signature

tuple_environment( : : Names : Values)

Herror tuple_environment(const char* Names, char* Values)

Herror T_tuple_environment(const Htuple Names, Htuple* Values)

void TupleEnvironment(const HTuple& Names, HTuple* Values)

HTuple HTuple::TupleEnvironment() const

static void HOperatorSet.TupleEnvironment(HTuple names, out HTuple values)

HTuple HTuple.TupleEnvironment()

def tuple_environment(names: MaybeSequence[str]) -> Sequence[str]

def tuple_environment_s(names: MaybeSequence[str]) -> str

Description

tuple_environmenttuple_environmentTupleEnvironmentTupleEnvironmenttuple_environment reads the content of all environment variables that are referenced by their names in the input tuple NamesNamesNamesnamesnames and returns the content with the output tuple ValuesValuesValuesvaluesvalues. The input tuple may only contain strings.

For general information about string operations see Tuple / String Operations.

Exception: Empty input tuples

If the input tuple is empty, the operator returns an empty tuple. Additionally, an empty string is returned for every name within NamesNamesNamesnamesnames that does not denote a valid environment variable.

HDevelop In-line Operation

HDevelop provides an in-line operation for tuple_environmenttuple_environmentTupleEnvironmentTupleEnvironmenttuple_environment, which can be used in an expression in the following syntax:

Values := environment(Names)

Execution Information

  • Multithreading type: independent (runs in parallel even with exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

NamesNamesNamesnamesnames (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Tuple containing name(s) of the environment variable(s).

ValuesValuesValuesvaluesvalues (output_control)  string(-array) → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Content of the environment variable(s).

Alternatives

tuple_strstrtuple_strstrTupleStrstrTupleStrstrtuple_strstr, tuple_strrstrtuple_strrstrTupleStrrstrTupleStrrstrtuple_strrstr, tuple_strchrtuple_strchrTupleStrchrTupleStrchrtuple_strchr, tuple_strrchrtuple_strrchrTupleStrrchrTupleStrrchrtuple_strrchr, tuple_strlentuple_strlenTupleStrlenTupleStrlentuple_strlen, tuple_str_first_ntuple_str_first_nTupleStrFirstNTupleStrFirstNtuple_str_first_n, tuple_str_last_ntuple_str_last_nTupleStrLastNTupleStrLastNtuple_str_last_n, tuple_splittuple_splitTupleSplitTupleSplittuple_split, tuple_substrtuple_substrTupleSubstrTupleSubstrtuple_substr

Module

Foundation

ClassesClasses | | Operators