All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

get-collection-item Generic Function

Summary

Returns the item at a specified position in a collection.

Package

capi

Signature

get-collection-item collection index

Arguments
collection
index
A non-negative integer.
Description

The generic function get-collection-item returns the item at position index from collection. It achieves this by calling the items-get-function of collection. There is also a complementary function, search-for-item which finds the index for a given item in a collection.

See also

collection
search-for-item


CAPI User Guide and Reference Manual (Unix version) - 01 Dec 2021 19:32:42