pdcomm_gem_result_spool_selection_at

Function

Reads one stream selection from an S2F43 request or S2F60 reply.

PdcommStatus pdcomm_gem_result_spool_selection_at(const PdcommGemResult *result, size_t index, uint8_t *stream, PdcommSecsItem **functions)

Declared in: #include <pdcomm_gem_spooling.h>

Applies to an incoming S2F43 request (Equipment) or a received S2F60 (Host).

Parameters

Name	Description
`result`	Spool request or response result.
`index`	Zero-based selection index.
`stream`	Receives the stream; set to 0 first. Must not be NULL.
`functions`	Receives a new U1 item listing the functions; an empty item means the whole stream. Set to NULL first. Must not be NULL.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when an argument is NULL; #PDCOMM_INVALID_STATE when the result is not an S2F43 request or S2F60 response; #PDCOMM_OUT_OF_RANGE when index is past the end; #PDCOMM_INVALID_DATA, #PDCOMM_LIMIT_EXCEEDED, #PDCOMM_ALLOCATION_FAILED, or #PDCOMM_INTERNAL_ERROR.

Notes

Ownership: release *functions with pdcomm_secs_destroy().