.\" 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_IOF_CHANNEL_STRING" "3" "Sep 27, 2026" "" "OpenPMIx"
.sp
\fBPMIx_IOF_channel_string\fP — Return the string representation of a
\fBpmix_iof_channel_t\fP value.
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <pmix.h>

const char* PMIx_IOF_channel_string(pmix_iof_channel_t channel);
.EE
.UNINDENT
.UNINDENT
.SS Python Syntax
.INDENT 0.0
.INDENT 3.5
.sp
.EX
from pmix import *

foo = PMIxClient()
# channel is an integer bitmask of PMIX_FWD_* channel flags
name = foo.iof_channel_string(PMIX_FWD_STDOUT_CHANNEL)
.EE
.UNINDENT
.UNINDENT
.SH INPUT PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBchannel\fP: An I/O forwarding channel specifier of type \fBpmix_iof_channel_t\fP\&.
This is a bitmask, so more than one channel flag may be set at once. Recognized
flags include \fBPMIX_FWD_STDIN_CHANNEL\fP, \fBPMIX_FWD_STDOUT_CHANNEL\fP,
\fBPMIX_FWD_STDERR_CHANNEL\fP, and \fBPMIX_FWD_STDDIAG_CHANNEL\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
Return a human\-readable, statically\-allocated string describing the given I/O
forwarding channel bitmask. Because \fBchannel\fP is a bitmask, the returned string
lists each recognized channel that is set, separated by spaces — for example,
\fB\(dqSTDOUT STDERR \(dq\fP when both the standard\-output and standard\-error channels are
selected. If no recognized channel bit is set, the string \fB\(dqNONE\(dq\fP is returned.
.sp
The returned pointer refers to storage owned by the PMIx library. The caller must
\fBnot\fP modify or free it. The buffer is reused on subsequent calls, so a returned
string should be copied if it must persist across another call to this function.
.SH RETURN VALUE
.sp
Returns a pointer to a constant, statically\-allocated character string. The pointer
is always non\-\fBNULL\fP and must not be freed by the caller.
.sp
\fBSee also:\fP
.INDENT 0.0
.INDENT 3.5
\fBPMIx_Job_state_string(3)\fP,
\fBPMIx_Device_type_string(3)\fP,
pmix_iof_channel_t(5) \%<#\:man5-pmix-iof-channel-t>
.UNINDENT
.UNINDENT
.SH Copyright
2014-2026, OpenPMIx Community
.\" End of generated man page.