Get Array Information
- Updated2023-02-17
- 4 minute(s) read
Get Array Information
Retrieves array information from a variant that contains an array data type. This node does not return information about values stored in the array.
This node returns an error if the variant does not contain an array.
variant
Variant data from which you want to retrieve data type information.
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
| error in does not contain an error | error in contains an error |
|---|---|
| If no error occurred before the node runs, the node begins execution normally.
If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out. | If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out. |
Default: No error
number of dimensions
Number of dimensions in the array stored in the variant.
array lengths
Type and length of each dimension of the array stored in the variant.
Type
Type of each dimension of the array stored in the variant.
| Name | Description |
|---|---|
| Variable | The memory of the array dimension can grow or shrink as needed to fit the data size. |
| Fixed | The memory of the array dimension is pre-allocated, and the data length cannot change. |
| Bounded | The memory of the array dimension has a maximum size and can store data with a length less than or equal to this size. |
Size
Length of each dimension of the array stored in the variant.
If Type is Variable, Size returns 0. If Type is Fixed or Bounded, Size returns the number of elements in each dimension of the array.
array element data type
Data type of elements of the array stored in the variant.
error out
Error information.
The node produces this output according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
| error in does not contain an error | error in contains an error |
|---|---|
| If no error occurred before the node runs, the node begins execution normally.
If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out. | If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out. |