Detailed Description

All the shared methods and fields required by file, memory and cached collections.

The state field points to the specific collection data structure and handles.

Examples: /home/runner/work/documentation/documentation/apis/51degrees-cxx/src/common/storedBinaryValue.h, and /home/runner/work/documentation/documentation/apis/51degrees-cxx/src/common/string.h.

Collaboration diagram for fiftyoneDegreesCollection:

Data Fields
fiftyoneDegreesCollectionGetMethod	get
	Gets an entry into the item provided.
fiftyoneDegreesCollectionReleaseMethod	release
	Releases the item handle.
fiftyoneDegreesCollectionFreeMethod	freeCollection
	Frees collection and all items retrieved from the collection will become invalid.
void *	state
	Pointer to data for memory, cache or file.
uint32_t	count
	The number of items, or 0 if not available.
uint32_t	elementSize
	The size of each entry, or 0 if variable length.
uint32_t	size
	Number of bytes in the source data structure containing the collection's data, or where offsetShift is non zero the number of offset units.
const char *	typeName
	Name of collection type (vtable).

Gets an entry into the item provided.

The consumer MUST release the item when it has finished with the data

void* fiftyoneDegreesCollection::state

Pointer to data for memory, cache or file.

The documentation for this struct was generated from the following file: