pdcomm_gem_spool_catalog_at
Function
Reads one catalog entry by position.
PdcommStatus pdcomm_gem_spool_catalog_at(PdcommTcpEndpoint *endpoint, size_t index, uint8_t *stream, uint8_t *function)Entries keep the order given to pdcomm_gem_configure_spooling() or persisted in the snapshot.
Parameters
| Name | Description |
|---|---|
endpoint | Endpoint with an Equipment spool. |
index | Zero-based catalog index. |
stream | Receives the stream; set to 0 first. Must not be NULL. |
function | Receives the function; set to 0 first. Must not be NULL or equal to stream. |
Returns
#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when an output is NULL, the outputs alias, or endpoint is NULL; #PDCOMM_OUT_OF_RANGE when index is past the end; #PDCOMM_INVALID_STATE when GEM is not configured or no Equipment spool is configured; #PDCOMM_POISONED after a contained panic.