Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
get_table_value [2013/08/08 20:02] admin created |
get_table_value [2026/08/28 03:22] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | Get a value from a table | + | Gets a value from a table. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Table | [[Table Type|Table]] | Table to extract the value from. | | + | | Table | [[Table Type]] | Table to extract the value from. | |
| - | | Keys | [[Tuple Type|Tuple]] | Keys corresponding to the desired value. | | + | | Keys | [[Tuple Type]] | Keys corresponding to the desired value. | |
| - | | Column | [[Index Or Name Type|Index Or Name]] | Column name or index where the value is located. | | + | | Column | [[Index Or Name Type]] | Column name or index where the value is located. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Value If Not Found | [[Table Value Type|Table Value]] | This value to be returned if any of the keys is not present in the table. | None | | + | | Value If Not Found | [[Table Value Type]] | Value returned if any of the given keys is not present in the table. If not provided, an error is reported when the keys are not found. This is an advanced port. | .none | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Result | [[Table Type|Table]] | Value extracted from table. | | + | | Result | [[Table Value Type]] | Value extracted from the table. | |
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Table|Table]] | + | [[Functor List#Table | Table]] |
| ===== Notes ===== | ===== Notes ===== | ||
| + | |||
| + | If the given keys are not found in the input table and Value If Not Found is not provided, this functor reports an error. | ||
| ===== Internal Name ===== | ===== Internal Name ===== | ||