Skip to content
Start free evaluation

pdcomm_gem300_capability_snapshot_capability_info

Function

Reads the axis, labels, and identifier length of one snapshot capability.

PdcommStatus pdcomm_gem300_capability_snapshot_capability_info(const PdcommGem300CapabilitySnapshot *snapshot, size_t profile_index, size_t capability_index, PdcommGem300CapabilityInfo *info)

Declared in: #include <pdcomm_gem300.h>

Parameters

NameDescription
snapshotLive snapshot.
profile_indexZero-based profile index.
capability_indexZero-based capability index within the profile, in input order.
infoCaller storage with struct_size, version, reserved, and reserved2 set. Reset to zero values once struct_size is accepted; filled on success.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when info or snapshot is NULL, or struct_size, version, reserved, or reserved2 is wrong; #PDCOMM_OUT_OF_RANGE when either index is out of range; #PDCOMM_INTERNAL_ERROR when a panic was contained.

Notes

  • Thread safety: snapshot reads may run concurrently; destruction must be synchronized with them.