table of contents
- unstable 7.0.0~rc1-1
| PMIX_INFO_LIST_PREPEND(3) | OpenPMIx | PMIX_INFO_LIST_PREPEND(3) |
PMIx_Info_list_prepend — Insert a key/value entry at the head of an opaque pmix_info_t(5) <#man5-pmix-info-t> list
SYNOPSIS¶
#include <pmix.h> pmix_status_t PMIx_Info_list_prepend(void *ptr,
const char *key,
const void *value,
pmix_data_type_t type);
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 the data value to be loaded.
- type: The pmix_data_type_t(5) <#man5-pmix-data-type-t> of the provided value.
DESCRIPTION¶
PMIx_Info_list_prepend behaves exactly like PMIx_Info_list_add(3) <#man3-pmix-info-list-add> except that the new pmix_info_t <#man5-pmix-info-t> entry is inserted at the head of the list identified by ptr rather than appended at the tail. This is useful when the order of entries matters and a particular directive must appear first.
The key and value are copied into the entry, so the caller’s source data may be modified or freed once the function returns. No duplicate-key check is performed.
RETURN VALUE¶
Returns PMIX_SUCCESS on success, or a negative PMIx error constant on failure — most commonly PMIX_ERR_NOMEM if the entry could not be allocated.
See also:
Copyright¶
2014-2026, OpenPMIx Community
| September 27, 2026 |