Skip to content
Start free evaluation

pdcomm_gem_result_formatted_program_query_id_get

Function

Copies the requested PPID of a query result as a new SECS-II item.

PdcommStatus pdcomm_gem_result_formatted_program_query_id_get(const PdcommGemResult *result, PdcommSecsItem **out_item)

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

Returns the PPID from the S7F25 request, for both the equipment's received request and the host's S7F26 result.

Parameters

NameDescription
resultQuery result.
out_itemReceives a new ASCII or Binary item. Set to NULL first when out_item is not NULL.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when result or out_item is NULL; #PDCOMM_INVALID_STATE when result is not a query result; #PDCOMM_ALLOCATION_FAILED when the item cannot be created; #PDCOMM_INTERNAL_ERROR when a panic was contained.

Notes

  • Ownership: release the item with pdcomm_secs_destroy(). It stays valid after the result and the endpoint are destroyed.