18.2.240. PMIx_Procid_invalid

PMIx_Procid_invalid — Test whether a pmix_proc_t(5) is invalid

18.2.240.1. SYNOPSIS

#include <pmix.h>

bool PMIx_Procid_invalid(const pmix_proc_t *p);

18.2.240.1.1. Python Syntax

No Python equivalent

18.2.240.2. INPUT PARAMETERS

p: Pointer to the pmix_proc_t(5) process identifier to be tested.

18.2.240.3. DESCRIPTION

Test whether a process identifier is invalid. A pmix_proc_t is considered invalid if either its namespace is invalid (NULL or empty, as determined by PMIx_Nspace_invalid(3)) or its rank is equal to PMIX_RANK_INVALID. A process identifier is valid only when both its namespace and its rank are valid.

18.2.240.4. RETURN VALUE

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

18.2.240.5. 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.