vlax-safearray-get-u-bound

vlax-safearray-get-l-bound

V Functions

vlax-safearray-put-element

 

AutoLISP Reference Guide > AutoLISP Functions > V Functions > 

vlax-safearray-get-u-bound

Returns the upper boundary (end index) of a dimension of an array

(vlax-safearray-get-u-bound var dim)

Arguments

var

A variable whose data type is a safearray.

dim

A dimension of the array. The first dimension is dimension 1.

Return Values

An integer representing the upper boundary (end index) of the dimension. If var is not an array, or dim is invalid (for example, 0, or a number greater than the number of dimensions in the array), an error results.

Examples

The following examples evaluate a safearray defined as follows:

(vlax-make-safearray vlax-vbString '(1 . 2) '(0 . 1) ))

Get the end index value of the array's first dimension:

_$ (vlax-safearray-get-u-bound
tmatrix 1)

2

The first dimension ends with index 2.

Get the end index value of the second dimension of the array:

_$ (vlax-safearray-get-u-bound
tmatrix 2)

1

The second dimension starts with index 1.