pdcomm_gem_formatted_program_store_info

Function

Reads the current store totals and limits.

PdcommStatus pdcomm_gem_formatted_program_store_info(PdcommTcpEndpoint *endpoint, PdcommGemFormattedProgramStoreInfo *info)

Declared in: #include <pdcomm_gem_formatted_program_store.h>

Parameters

Name	Description
endpoint	Equipment endpoint with the formatted program query service configured.
info	Caller storage with struct_size, version, and reserved set. On success every field is written.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or info is NULL, or the info header is invalid; #PDCOMM_INVALID_STATE when the endpoint is not an Equipment or the query service is not configured; #PDCOMM_BACKPRESSURE when a staged TCP event must be drained first; #PDCOMM_POISONED when the endpoint is poisoned.

Notes

• Thread safety: serialize with every other call on endpoint.