pdcomm_gem_spool_state

Function

Reads the current Equipment spool state.

PdcommStatus pdcomm_gem_spool_state(PdcommTcpEndpoint *endpoint, PdcommGemSpoolState *state)

Declared in: #include <pdcomm_gem_spooling.h>

synchronized reflects whether the last pdcomm_gem_spool_sync() still matches the current connection, so it can be 0 even right after a successful sync if the connection has changed since.

Parameters

Name	Description
endpoint	Endpoint with an Equipment spool.
state	Caller storage with struct_size set. All known fields are cleared first and written on success.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when state is NULL or too small, or endpoint is NULL; #PDCOMM_INVALID_STATE when no Equipment spool is configured; #PDCOMM_POISONED after a contained panic.