18.2.102. PMIx_Info_list_xfer

PMIx_Info_list_xfer — Copy an existing pmix_info_t(5) onto an opaque list

18.2.102.1. SYNOPSIS

#include <pmix.h>

pmix_status_t PMIx_Info_list_xfer(void *ptr,
                                  const pmix_info_t *info);

18.2.102.1.1. Python Syntax

No Python equivalent

18.2.102.2. INPUT PARAMETERS

ptr: Opaque list handle returned by PMIx_Info_list_start(3).
info: Pointer to the source pmix_info_t to be copied onto the list.

18.2.102.3. DESCRIPTION

Create a new pmix_info_t entry on the list identified by ptr and copy the full contents of the source info into it. All fields — the key, the value, and the info directives (flags) — are deep-copied. The new entry is appended to the end of the list.

Because the transfer is a copy, the source info (and any memory it references) may be modified or freed once the function returns without affecting the stored copy. This is the key distinction from PMIx_Info_list_insert(3), which stores the source by reference and leaves ownership with the caller.

No duplicate-key check is performed; use PMIx_Info_list_xfer_unique(3) when duplicate suppression is required.

18.2.102.4. RETURN VALUE

Returns PMIX_SUCCESS on success, or a negative PMIx error constant such as PMIX_ERR_NOMEM if the entry could not be allocated.