Scroll to navigation

PMIX_INFO_LIST_XFER(3) OpenPMIx PMIX_INFO_LIST_XFER(3)

PMIx_Info_list_xfer — Copy an existing pmix_info_t(5) <#man5-pmix-info-t> onto an opaque list

SYNOPSIS

#include <pmix.h>
pmix_status_t PMIx_Info_list_xfer(void *ptr,


                                  const pmix_info_t *info);


Python Syntax

No Python equivalent

INPUT PARAMETERS

  • ptr: Opaque list handle returned by PMIx_Info_list_start(3) <#man3-pmix-info-list-start>.
  • info: Pointer to the source pmix_info_t <#man5-pmix-info-t> to be copied onto the list.

DESCRIPTION

Create a new pmix_info_t <#man5-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) <#man3-pmix-info-list-insert>, 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) <#man3-pmix-info-list-xfer-unique> when duplicate suppression is required.

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.

See also:

PMIx_Info_list_start(3) <#man3-pmix-info-list-start>, PMIx_Info_list_xfer_unique(3) <#man3-pmix-info-list-xfer-unique>, PMIx_Info_list_add(3) <#man3-pmix-info-list-add>, PMIx_Info_list_insert(3) <#man3-pmix-info-list-insert>, PMIx_Info_list_convert(3) <#man3-pmix-info-list-convert>, PMIx_Info_list_release(3) <#man3-pmix-info-list-release>, pmix_info_t(5) <#man5-pmix-info-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026