AutoGen - The Automated Program Generator: 3.4.18 high-lim - get highest value index

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

### 3.4.18 ``high-lim'` - get highest value index

Usage: (high-lim ag-name)
Returns the highest index associated with an array of definitions. This is generally, but not necessarily, one less than the `count` value. (The indexes may be specified, rendering a non-zero based or sparse array of values.)

This is very useful for specifying the size of a zero-based array of values where not all values are present. For example:

    tMyStruct myVals[ [+ (+ 1 (high-lim "my-val-list")) +] ];

Arguments:
ag-name - name of AutoGen value

This document was generated by Bruce Korb on October, 7 2007 using texi2html 1.76.