pdcomm_gem_program_get

Function

Copies the body of a stored program by PPID.

PdcommStatus pdcomm_gem_program_get(PdcommTcpEndpoint *endpoint, const PdcommSecsItem *id, PdcommSecsItem **out_body)

Declared in: #include <pdcomm_gem_programs.h>

Parameters

Name	Description
`endpoint`	Endpoint with a program store.
`id`	PPID item (ASCII or Binary); the format must match the stored PPID.
`out_body`	Receives a new PPBODY item; set to NULL first. Must not be NULL.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when an argument is NULL or id is not an ASCII or Binary item; #PDCOMM_INVALID_STATE when no program store is configured; #PDCOMM_OUT_OF_RANGE when no program has this PPID; #PDCOMM_BACKPRESSURE when a staged TCP event is pending; #PDCOMM_LIMIT_EXCEEDED, #PDCOMM_ALLOCATION_FAILED, or #PDCOMM_POISONED.

Notes

Ownership: release *out_body with pdcomm_secs_destroy().