Name
extract
Synopsis
int extract(arrayarray[, inttype[, stringprefix]])
Sets the value of variables to the values of elements from an array. For each element in the array, the key is used to determine the variable name to set, and that variable is set to the value of the element.
The second argument, if given, takes one of the following values to determine behavior if the values in the array have the same name as variables already existing in the local scope:
| Overwrite the existing variable |
| Don’t overwrite the existing variable (ignore the value provided in the array) |
| Prefix the variable name with the string given as the third argument |
| Prefix all variable names with the string given as the third argument |
| Prefix any invalid or numeric variable names with the string given as the third argument |
| Only replace variable if it exists in the current symbol table |
| Only create prefixed variable names if the nonprefixed version of the same variable exists |
| Extract variables as references |
The function returns the number of successfully set variables.
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access