table of contents
- unstable 7.0.0~rc1-1
| PMIX_INFO_LIST_ADD_VALUE_UNIQUE(3) | OpenPMIx | PMIX_INFO_LIST_ADD_VALUE_UNIQUE(3) |
PMIx_Info_list_add_value_unique — Append an entry to an opaque pmix_info_t(5) <#man5-pmix-info-t> list from a key and pmix_value_t, only if the key is not already present
SYNOPSIS¶
#include <pmix.h> pmix_status_t PMIx_Info_list_add_value_unique(void *ptr,
const char *key,
const pmix_value_t *value,
bool overwrite);
Python Syntax¶
No Python equivalent
INPUT PARAMETERS¶
- ptr: Opaque list handle returned by PMIx_Info_list_start(3) <#man3-pmix-info-list-start>.
- key: String key to be loaded. Must be no longer than PMIX_MAX_KEYLEN.
- value: Pointer to a pmix_value_t whose contents are to be copied into the entry.
- overwrite: If true and an entry with the same key already exists, its value is replaced with a copy of the provided one. If false, an existing entry is left unchanged.
DESCRIPTION¶
Add a key/value entry to the list identified by ptr using an already-constructed pmix_value_t, enforcing key uniqueness. This is the pmix_value_t analogue of PMIx_Info_list_add_unique(3) <#man3-pmix-info-list-add-unique>.
The list is first scanned for an existing entry whose key matches key:
- If a match is found and overwrite is true, the existing value is destructed and replaced with a copy of the provided value. No new entry is appended.
- If a match is found and overwrite is false, the list is left unchanged.
- If no match is found, a new entry is created from key and value and appended to the end of the list.
The value is transferred with a deep copy; the caller’s value may be modified or freed once the function returns.
RETURN VALUE¶
Returns PMIX_SUCCESS when the entry was added, updated, or intentionally left unchanged; or a negative PMIx error constant such as PMIX_ERR_NOMEM if a new entry could not be allocated, or any error returned while copying the value.
See also:
Copyright¶
2014-2026, OpenPMIx Community
| September 27, 2026 |