prg_vector_access()
Abstract
Obtains the address of an element stored in the vector. The element is specified by its position.
Syntax
prg_vector_access (vector_ptr, pos_index)
| Argument | Type | Description |
|---|---|---|
vector_ptr |
PrgT_Vector * |
vector of interest |
pos_index |
unsigned long |
zero-indexed position for the element of interest |
Return Type
void *
address of the element at the specified position; NIL if position is out of range.
Header
prg_vector.h
Details
If the position of an element of interest is known, its address can be obtained by calling this function. The element is not removed from the vector. The position is zero-indexed and must be within bounds (i.e., non-negative, and less than the number of elements in the vector). Otherwise the NIL pointer is returned.