Get started C API

The public C API of Get started.

All kindsFunctionMacroTypedef23 symbols

• PDCOMM_ALLOCATION_FAILED Macro — A memory allocation failed.
• PDCOMM_BUFFER_TOO_SMALL Macro — The output capacity is smaller than the data.
• PDCOMM_INTERNAL_ERROR Macro — An internal invariant failed or a panic was contained.
• PDCOMM_INVALID_ARGUMENT Macro — An argument is invalid.
• PDCOMM_INVALID_DATA Macro — The input bytes are not a valid SECS-II item.
• PDCOMM_IO_ERROR Macro — An operating-system operation failed.
• PDCOMM_LICENSE_REQUIRED Macro — A PDComm license that grants the module is required.
• PDCOMM_LIMIT_EXCEEDED Macro — The request exceeds an application-supplied or protocol limit.
• PDCOMM_OK Macro — The call succeeded.
• PDCOMM_OUT_OF_RANGE Macro — An index or identifier does not refer to an existing element.
• PDCOMM_TRUNCATED Macro — The input ended before a complete SECS-II item was read.
• PdcommBuffer Typedef — Opaque, immutable, owned byte buffer.
• PdcommStatus Typedef — Result code returned by fallible PDComm functions.
• pdcomm_abi_version Function — Returns the ABI version implemented by the loaded library.
• pdcomm_buffer_copy Function — Copies the bytes of a buffer into caller storage.
• pdcomm_buffer_create Function — Copies caller bytes into a new owned buffer.
• pdcomm_buffer_destroy Function — Releases a buffer handle.
• pdcomm_license_host_id Function — Copies the host id of this machine.
• pdcomm_license_install Function — Installs PDComm license text for this library.
• pdcomm_license_status Function — Copies the license status of this library as a JSON object.
• pdcomm_logging_configure Function — Configures library-local diagnostics logging.
• pdcomm_logging_flush Function — Waits until queued log records are written to the sink.
• pdcomm_logging_status Function — Copies the current logging status as a JSON object.