Skip to content
Start free evaluation

pdcomm_gem_spool_selection_at

Function

Reads one stream selection of the current local selection.

PdcommStatus pdcomm_gem_spool_selection_at(PdcommTcpEndpoint *endpoint, size_t index, uint8_t *stream, PdcommSecsItem **functions)

Declared in: #include <pdcomm_gem_spooling.h>

Parameters

NameDescription
endpointEndpoint with an Equipment spool.
indexZero-based selection index.
streamReceives the stream; set to 0 first. Must not be NULL.
functionsReceives a new U1 item listing the selected functions; an empty item selects the whole stream. Set to NULL first. Must not be NULL.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when an output or endpoint is NULL; #PDCOMM_INVALID_STATE when no Equipment spool is configured; #PDCOMM_OUT_OF_RANGE when index is past the end; #PDCOMM_LIMIT_EXCEEDED when the list exceeds the GEM item limits; #PDCOMM_ALLOCATION_FAILED or #PDCOMM_POISONED.

Notes

  • Ownership: release *functions with pdcomm_secs_destroy().