Reads the value of all the elements found in a matrix column.

// Read the elements found in column 5

ResReadColumn = MatReadColumn("MyMatrix", 5)

Syntax

<Result> = MatReadColumn(<Matrix> , <ColumnÂ toÂ read> [,Â <TotalÂ elementÂ size> [,Â <NumberÂ ofÂ decimals> [,Â <ElementÂ format>]]])

<Result>: Character string

Value of all the elements found in the specified column, in the following format:

<Value of element 1> + TAB + <Value of element 2> + TAB + ...

+ TAB + <Value of element N>

<Matrix>: Character string

Name of the matrix to be read, defined with MatCreate.

<Column to read>: Integer

Number of the column to read.

<Total element size>: Optional integer

Total size of an element to read. This size includes the sign, the thousand separator, the decimal point, the exponent, the integer parts and the decimal parts of the element value.- If the element has more than <Total element size> digits, <Total element size> is increased.
- If the element has less than <Total element size> digits, <Result> is filled with spaces.
- If <Total element size> is not specified, the value of the element read will have the size of its significant part.
- <Total element size> must not exceed 100.
- If <Total element size> is set to 0, the value of the element will have the size of its significant part.

<Number of decimals>: Optional integer

Number of decimals to read. This parameter always starts with a dot ("."). The last decimal will be rounded. This parameter only affects the float notations ("f") and the exponential notations ("e" and "E"). <Total element size> is ignored if <Number of decimals> is greater than <Total element size>. | | |

*<Number of decimals>* | *"d" type (integer)* | *"e" or "E" type (exponential notation) and "f" type (float notation)* |
---|

.0 | - | 0 |

.N | - | N (if N is greater than the number of decimals, the decimal part will be filled with zeros) |

(not specified) | - | 6 |

<Element format>: Optional character

Format for representing an element:- d: the value of the element is expressed as a signed integer. The digits found after the decimal point are truncated and <Number of decimals> is ignored.
- e or E: the value of the element is expressed as an exponential notation with 1 digit before the decimal point, <Number of decimals> digits after the decimal point and at least 2 digits in the exponent.

Remarks

The matrix existence is not checked. To check the matrix existence, use

MatExist.

**Caution**:

**MatReadColumn** returns no error code. To find out whether errors have been generated when reading the column elements, use

MatError. To get more details on the error, use

ErrorInfo with the

*errMessage* constant.

**Caution**: The size of the character string returned in <Result> cannot exceed 260 characters. If the matrix column contains more characters, the string found in <Result> will only contain the first 260 characters.

Extracting an element value from <Result>

To extract one or more element values from <Result>, use

ExtractString.

Business / UI classification: Neutral code