Scroll to navigation

PMIX_PROCID_INVALID(3) OpenPMIx PMIX_PROCID_INVALID(3)

PMIx_Procid_invalid — Test whether a pmix_proc_t(5) <#man5-pmix-proc-t> is invalid

SYNOPSIS

#include <pmix.h>
bool PMIx_Procid_invalid(const pmix_proc_t *p);


Python Syntax

No Python equivalent

INPUT PARAMETERS

•
p: Pointer to the pmix_proc_t(5) <#man5-pmix-proc-t> process identifier to be tested.

DESCRIPTION

Test whether a process identifier is invalid. A pmix_proc_t <#man5-pmix-proc-t> is considered invalid if either its namespace is invalid (NULL or empty, as determined by PMIx_Nspace_invalid(3) <#man3-pmix-nspace-invalid>) or its rank is equal to PMIX_RANK_INVALID. A process identifier is valid only when both its namespace and its rank are valid.

RETURN VALUE

Returns true if the process identifier is invalid (invalid namespace or PMIX_RANK_INVALID rank), and false otherwise.

NOTES

PMIx_Procid_invalid is an OpenPMIx convenience routine and is the backing implementation of the PMIX_PROCID_INVALID macro. The argument must point to a valid structure; the routine dereferences p and performs no NULL checking on the pointer itself.

See also:

PMIx_Nspace_invalid(3) <#man3-pmix-nspace-invalid>, PMIx_Check_procid(3) <#man3-pmix-check-procid>, PMIx_Load_procid(3) <#man3-pmix-load-procid>, pmix_proc_t(5) <#man5-pmix-proc-t>


Copyright

2014-2026, OpenPMIx Community

September 27, 2026