.\" 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_DIRECTIVES_STRING" "3" "Sep 27, 2026" "" "OpenPMIx"
.sp
\fBPMIx_Info_directives_string\fP — Return an allocated string representation of a pmix_info_directives_t(5) \%<#\:man5-pmix-info-directives-t> bit\-mask.
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <pmix.h>

char* PMIx_Info_directives_string(pmix_info_directives_t directives);
.EE
.UNINDENT
.UNINDENT
.SS Python Syntax
.INDENT 0.0
.INDENT 3.5
.sp
.EX
from pmix import *

foo = PMIxClient()
# directives is an integer bit\-mask of PMIX_INFO_* flags
string = foo.info_directives_string(PMIX_INFO_REQD)
.EE
.UNINDENT
.UNINDENT
.SH INPUT PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBdirectives\fP: A pmix_info_directives_t(5) \%<#\:man5-pmix-info-directives-t>
bit\-mask of \fBPMIX_INFO_*\fP flags to be rendered.
.UNINDENT
.SH DESCRIPTION
.sp
Build a human\-readable rendering of the supplied
pmix_info_directives_t(5) \%<#\:man5-pmix-info-directives-t> bit\-mask. The set
flags are rendered as colon\-separated tokens, for example \fBQUALIFIER\fP for
\fBPMIX_INFO_QUALIFIER\fP, \fBREQUIRED\fP for \fBPMIX_INFO_REQD\fP (\fBOPTIONAL\fP when the
required bit is clear), \fBPROCESSED\fP for \fBPMIX_INFO_REQD_PROCESSED\fP, and \fBEND\fP
for \fBPMIX_INFO_ARRAY_END\fP\&. When no recognized bit is set, the string
\fBUNSPECIFIED\fP is returned.
.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_directives_string\fP returns a freshly
\fBheap\-allocated\fP buffer (produced with \fBstrdup\fP or the library’s argv\-join
helper, both of which use \fBmalloc\fP). The \fBcaller is responsible for releasing
it\fP with the standard C library \fBfree()\fP when it is no longer needed.
.SH RETURN VALUE
.sp
Returns a pointer to an allocated, NULL\-terminated string that the caller must
release with \fBfree()\fP\&. Because the argument is passed by value, this routine
always returns an allocated string (\fBUNSPECIFIED\fP when no recognized flag is set)
rather than \fBNULL\fP\&.
.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.
.sp
\fBSee also:\fP
.INDENT 0.0
.INDENT 3.5
PMIx_Info_construct(3) \%<#\:man3-pmix-info-construct>,
PMIx_Info_string(3) \%<#\:man3-pmix-info-string>
.UNINDENT
.UNINDENT
.SH Copyright
2014-2026, OpenPMIx Community
.\" End of generated man page.