Skip to content
Start free evaluation

pdcomm_gem_formatted_program_query_remove

Function

Removes a program from the Equipment store (compatibility alias).

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

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

Equipment only. Equivalent to pdcomm_gem_formatted_program_store_remove(), including its status codes.

Parameters

NameDescription
endpointEquipment endpoint with this service configured.
idPPID item (ASCII or Binary) to remove.
out_removedReceives 1 when an entry was removed and 0 otherwise. Set to 0 once both pointers are non-NULL.

Returns

#PDCOMM_OK on success, including when the PPID was absent; #PDCOMM_INVALID_ARGUMENT when endpoint, id, or out_removed is NULL, id is not an ASCII or Binary item, or the PPID is empty or longer than 120 bytes; #PDCOMM_INVALID_STATE when the endpoint is not an Equipment, the 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.

Privacy Policy