.\" 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_VALUE_CREATE" "3" "Sep 27, 2026" "" "OpenPMIx"
.sp
\fBPMIx_Value_create\fP — Allocate and initialize an array of
pmix_value_t(5) \%<#\:man5-pmix-value-t> structures.
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <pmix.h>

pmix_value_t* PMIx_Value_create(size_t n);
.EE
.UNINDENT
.UNINDENT
.SS Python Syntax
.sp
No Python equivalent
.SH INPUT PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBn\fP: Number of pmix_value_t(5) \%<#\:man5-pmix-value-t> structures to
allocate.
.UNINDENT
.SH DESCRIPTION
.sp
Allocate a contiguous array of \fBn\fP pmix_value_t(5) \%<#\:man5-pmix-value-t> structures on the heap and construct each element
(zeroing it and setting its \fBtype\fP to \fBPMIX_UNDEF\fP), exactly as
PMIx_Value_construct(3) \%<#\:man3-pmix-value-construct> does for a single
value.
.sp
The returned array is owned by the caller and must be released with
PMIx_Value_free(3) \%<#\:man3-pmix-value-free>, passing the same count
\fBn\fP, which destructs the contents of each element and frees the array
storage.
.SH RETURN VALUE
.sp
Returns a pointer to the newly allocated array of
pmix_value_t(5) \%<#\:man5-pmix-value-t> structures on success.
.sp
Returns \fBNULL\fP if \fBn\fP is zero or if the allocation fails.
.SH NOTES
.sp
\fBPMIx_Value_create\fP is an OpenPMIx convenience routine. The corresponding
macro\-style interface for this operation is \fBPMIX_VALUE_CREATE\fP\&.
.SH EXAMPLES
.sp
Create and later release an array of values:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
pmix_value_t *array;

array = PMIx_Value_create(4);
if (NULL == array) {
    /* handle allocation failure */
}

/* ... use the array ... */

PMIx_Value_free(array, 4);
.EE
.UNINDENT
.UNINDENT
.sp
\fBSee also:\fP
.INDENT 0.0
.INDENT 3.5
PMIx_Value_free(3) \%<#\:man3-pmix-value-free>,
PMIx_Value_construct(3) \%<#\:man3-pmix-value-construct>,
PMIx_Value_destruct(3) \%<#\:man3-pmix-value-destruct>,
PMIx_Value_load(3) \%<#\:man3-pmix-value-load>,
PMIx_Value_xfer(3) \%<#\:man3-pmix-value-xfer>,
pmix_value_t(5) \%<#\:man5-pmix-value-t>
.UNINDENT
.UNINDENT
.SH Copyright
2014-2026, OpenPMIx Community
.\" End of generated man page.