18.3.9. pmix_boolean_t

pmix_boolean_t — Tri-state boolean enumeration

18.3.9.1. SYNTAX

18.3.9.1.1. C Syntax

#include <pmix_common.h>

typedef enum {
    PMIX_BOOL_TRUE,
    PMIX_BOOL_FALSE,
    PMIX_NON_BOOL
} pmix_boolean_t;

18.3.9.2. DESCRIPTION

The pmix_boolean_t enumeration provides a tri-state boolean value. In addition to the usual true and false states, it distinguishes a third state that indicates the value being examined is not a boolean at all — for example, when interpreting the value carried by a pmix_info_t(5) structure.

The enumerated values are:

PMIX_BOOL_TRUE — The value is boolean and evaluates to true.
PMIX_BOOL_FALSE — The value is boolean and evaluates to false.
PMIX_NON_BOOL — The value is not a boolean value.