pdcomm_gem_formatted_program_store_remove

Function

Removes a program from the local store.

PdcommStatus pdcomm_gem_formatted_program_store_remove(PdcommTcpEndpoint *endpoint, const PdcommSecsItem *id, uint8_t *out_removed)

Declared in: #include <pdcomm_gem_formatted_program_store.h>

Equipment only. Removing an absent PPID is not an error.

Parameters

Name	Description
`endpoint`	Equipment endpoint with the formatted program query service configured.
`id`	PPID item (ASCII or Binary) to remove.
`out_removed`	Receives 1 when an entry was removed and 0 otherwise. Set to 0 once both pointers are non-NULL.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint, id, or out_removed is NULL, or the PPID is not a nonempty ASCII or Binary item of at most 120 bytes; #PDCOMM_INVALID_STATE when the endpoint is not an Equipment, the query service is not configured, or a transfer response is updating the store; #PDCOMM_LIMIT_EXCEEDED when the store revision is exhausted; #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.