Skip to content
Start free evaluation

pdcomm_gem_program_delete_local

Function

Deletes stored programs locally.

PdcommStatus pdcomm_gem_program_delete_local(PdcommTcpEndpoint *endpoint, const PdcommSecsItem *const *ids, size_t count, PdcommGemProgramWriteInfo *info)

Declared in: #include <pdcomm_gem_programs.h>

Requires a stopped endpoint. A zero count deletes every program (NULL and 0 is accepted); this API has no way to express an explicit empty selection. Listed PPIDs must be distinct and present.

Parameters

NameDescription
endpointStopped endpoint with a program store.
idsArray of count PPID items. May be NULL when count is 0; no element may be NULL.
countNumber of PPIDs; at most max_request_ids.
infoReceives the outcome. Must not be NULL.

Returns

#PDCOMM_OK or #PDCOMM_PROGRAM_UNCONFIRMED when installed; #PDCOMM_INVALID_ARGUMENT for a NULL or short argument, a PPID that is not ASCII or Binary or is empty, or a repeated PPID; #PDCOMM_OUT_OF_RANGE when a PPID is not stored; #PDCOMM_LIMIT_EXCEEDED when count or a PPID length exceeds its limit; #PDCOMM_INVALID_STATE when the endpoint is not stopped or has no program store; #PDCOMM_BACKPRESSURE when a staged TCP event is pending; a persistence error such as #PDCOMM_IO_ERROR (store unchanged); #PDCOMM_ALLOCATION_FAILED or #PDCOMM_POISONED.