18.2.111. PMIx_Info_list_prepend

PMIx_Info_list_prepend — Insert a key/value entry at the head of an opaque pmix_info_t(5) list

18.2.111.1. SYNOPSIS

#include <pmix.h>

pmix_status_t PMIx_Info_list_prepend(void *ptr,
                                     const char *key,
                                     const void *value,
                                     pmix_data_type_t type);

18.2.111.1.1. Python Syntax

No Python equivalent

18.2.111.2. INPUT PARAMETERS

ptr: Opaque list handle returned by PMIx_Info_list_start(3).
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) of the provided value.

18.2.111.3. DESCRIPTION

PMIx_Info_list_prepend behaves exactly like PMIx_Info_list_add(3) except that the new 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.

18.2.111.4. 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.