void* pblSetElement

( PblSet* set )

Retrieves, but does not remove, the head (first element) of this set.

Documentation

Retrieves, but does not remove, the head (first element) of this set.

Retrieving the first element of a hash set has a time complexity of O(N), with N being the capacity of the set.

Retrieving the first element of a tree set has a time complexity of O(Log N), with N being the size of the set.

Parameters:

set - The set to use

Returns:

void * retptr != NULL: The first element of this set.
void * retptr == NULL: An error, see pbl_errno:
PBL_ERROR_OUT_OF_BOUNDS - this set is empty.

Alphabetic index