pdcomm_gem300_capability_catalog_clear

Function

Removes every profile from the catalog.

PdcommStatus pdcomm_gem300_capability_catalog_clear(PdcommGem300CapabilityCatalog *catalog, uint64_t *out_revision, uint8_t *out_changed)

Declared in: #include <pdcomm_gem300.h>

Clearing a nonempty catalog increments the revision. Clearing an empty catalog succeeds with *out_changed 0 and the revision unchanged.

Parameters

Name	Description
`catalog`	Catalog to clear.
`out_revision`	Receives the revision after the call. Must not be NULL; set to 0 before validation.
`out_changed`	Receives 1 when profiles were removed, otherwise 0. Must not be NULL; set to 0 before validation.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when catalog or an output is NULL; #PDCOMM_LIMIT_EXCEEDED when the revision counter is exhausted; #PDCOMM_INTERNAL_ERROR when a panic was contained.

Notes

Thread safety: serialize with every other call on the same catalog.