17.3.3. pmix_status_t — OpenPMIx 6.1.1rc2 documentation

# 17.3.3. pmix_status_t

pmix_status_t — An int compatible value for return status codes.

## 17.3.3.1. SYNTAX

### 17.3.3.1.1. C Syntax

    #include <pmix_common.h>

    typedef int pmix_status_t;

### 17.3.3.1.2. Python Syntax

    from pmix import *

    foo = PMIxStatus.status

where `status` is a PMIx-defined status code (e.g., `PMIX_SUCCESS`)

## 17.3.3.2. DESCRIPTION

PMIx return values other than `PMIX_SUCCESS` are required to always be negative. The return status value for a successful operation is `PMIX_SUCCESS`, which must have an integer value of 0.

## 17.3.3.3. ERRORS

PMIx `errno` values are defined in `pmix_common.h`.

See also

PMIx_Initialized(3), PMIx_Abort(3), PMIx_Commit(3), PMIx_Finalize(3), PMIx_Put(3), pmiAddInstance(3), pmiAddMetric(3)