pdcomm_gem_configure_formatted_program_queries

Function

Enables the S7F25/S7F26 service on an endpoint.

PdcommStatus pdcomm_gem_configure_formatted_program_queries(PdcommTcpEndpoint *endpoint, const PdcommGemFormattedProgramQueryOptions *options)

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

Call it once per endpoint, after the GEM role is configured and while the endpoint is stopped. Both roles may configure it: the Host sends requests, and the Equipment answers them from its program store. On the Equipment the call also creates the formatted program store, the local selection state, and the execution state that later headers use.

Parameters

Name	Description
endpoint	Stopped endpoint with a configured GEM role.
options	Service and store limits. Read only during the call.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or options is NULL, options->struct_size is too small, version or reserved is wrong, a queue limit (max_pending, max_received, max_results, max_history) is 0, or max_catalog_entries times the endpoint's message_bytes limit overflows; #PDCOMM_INVALID_STATE when the endpoint is not stopped, has a staged TCP event, has no GEM role, or already has this service; #PDCOMM_LIMIT_EXCEEDED when max_commands is too large or the store storage for max_catalog_entries cannot be reserved; #PDCOMM_ALLOCATION_FAILED when the queues cannot be allocated; #PDCOMM_POISONED when the endpoint is poisoned.

Notes

• Thread safety: serialize with every other call on endpoint.