.\" Man page generated from reStructuredText
.\" by the Docutils 0.23 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PMIX_INFO_STRING" "3" "Sep 27, 2026" "" "OpenPMIx"
.sp
\fBPMIx_Info_string\fP — Return an allocated string representation of a pmix_info_t(5) \%<#\:man5-pmix-info-t>\&.
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <pmix.h>

char* PMIx_Info_string(const pmix_info_t *info);
.EE
.UNINDENT
.UNINDENT
.SS Python Syntax
.INDENT 0.0
.INDENT 3.5
.sp
.EX
from pmix import *

foo = PMIxClient()
# the info is a Python \(ga\(gapmix_info_t\(ga\(ga dictionary
pyinfo = {\(aqkey\(aq: PMIX_JOB_SIZE, \(aqvalue\(aq: 4, \(aqval_type\(aq: PMIX_UINT32}
rc, txt = foo.info_string(pyinfo)
.EE
.UNINDENT
.UNINDENT
.SH INPUT PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBinfo\fP: Pointer to the pmix_info_t(5) \%<#\:man5-pmix-info-t> structure to be
rendered.
.UNINDENT
.SH DESCRIPTION
.sp
Build a human\-readable rendering of the supplied pmix_info_t(5) \%<#\:man5-pmix-info-t>,
including its key, the type and contents of its embedded
pmix_value_t(5) \%<#\:man5-pmix-value-t>, and its directive flags. The rendering is
produced by the same internal print routine used elsewhere in the library, followed
by a trailing newline.
.sp
Unlike the \fBconst char*\fP converter routines (such as
PMIx_Error_string(3) \%<#\:man3-pmix-error-string>), which return a pointer to
storage owned by the library, \fBPMIx_Info_string\fP returns a freshly
\fBheap\-allocated\fP buffer. The buffer is allocated with the library’s \fBasprintf\fP
wrapper, so the \fBcaller is responsible for releasing it\fP with the standard C
library \fBfree()\fP when it is no longer needed. Failing to do so leaks the buffer.
.SH RETURN VALUE
.sp
Returns a pointer to an allocated, NULL\-terminated string that the caller must
release with \fBfree()\fP\&.
.sp
Returns \fBNULL\fP if the information could not be rendered — for example, if
\fBinfo\fP is \fBNULL\fP or references an unknown data type.
.SH NOTES
.sp
The returned buffer must be freed with \fBfree()\fP; do not pass it to
\fBPMIX_RELEASE\fP or any other PMIx destructor macro. This routine is a library
convenience function and is not part of the PMIx Standard.
.sp
\fBSee also:\fP
.INDENT 0.0
.INDENT 3.5
PMIx_Info_construct(3) \%<#\:man3-pmix-info-construct>,
PMIx_Value_string(3) \%<#\:man3-pmix-value-string>
.UNINDENT
.UNINDENT
.SH Copyright
2014-2026, OpenPMIx Community
.\" End of generated man page.