pdcomm_gem_formatted_program_execution_snapshot

Function

Captures the endpoint's current execution state as a snapshot.

PdcommStatus pdcomm_gem_formatted_program_execution_snapshot(PdcommTcpEndpoint *endpoint, PdcommGemFormattedProgramExecutionSnapshotHandle **out_snapshot)

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

Works in every state, including EMPTY.

Parameters

Name	Description
endpoint	Equipment endpoint with formatted program queries configured.
out_snapshot	Receives the snapshot. When endpoint is valid and not poisoned, it is set to NULL first, so it is NULL after every later failure.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or out_snapshot is NULL; #PDCOMM_INVALID_STATE when the endpoint is not a GEM equipment or formatted program queries are not configured; #PDCOMM_LIMIT_EXCEEDED or #PDCOMM_ALLOCATION_FAILED when the copy cannot be created; #PDCOMM_POISONED.

Notes

• Ownership: release the snapshot with pdcomm_gem_formatted_program_execution_snapshot_destroy().