18.2.268. PMIx_parse_regex2

PMIx_parse_regex2 — Expand an encoded representation produced by PMIx_generate_regex2 back into its list of values.

18.2.268.1. SYNOPSIS

#include <pmix_server.h>

pmix_status_t PMIx_parse_regex2(const pmix_regex2_t *regex,
                                pmix_info_t info[], size_t ninfo,
                                char **output);

18.2.268.1.1. Python Syntax

No Python equivalent

18.2.268.2. INPUT PARAMETERS

regex: Pointer to a pmix_regex2_t(5) structure as returned by PMIx_generate_regex2(3). Its colon-delimited type prefix selects the decoding method.
info: Optional array of pmix_info_t(5) directives influencing the expansion (see DIRECTIVES). May be NULL.
ninfo: Number of elements in the info array; zero if none.

18.2.268.3. OUTPUT PARAMETERS

output: Address where a pointer to a freshly allocated, NULL-terminated string containing the comma-separated list of the individual values is returned. The caller is responsible for releasing the returned string with free().

18.2.268.4. DESCRIPTION

Given a pmix_regex2_t as returned by PMIx_generate_regex2(3), expand the encoded representation and return a NULL-terminated string of the individual values in output. The order of the values is identical to the order of the values in the original input string passed to PMIx_generate_regex2.

The type prefix carried by the regex structure identifies the encoding method (e.g., "pmix", "raw", or "blob") so that the library can select the corresponding decoder. This is the reciprocal operation of PMIx_generate_regex2(3).

The operation is performed synchronously in the caller’s thread; it does not thread-shift into the PMIx progress engine and does not invoke a callback.

18.2.268.5. DIRECTIVES

The info array is provided so that decoding behavior can be tuned or extended without changing the API signature. No standardized attributes are currently defined for this API; an implementation is free to define its own, and unrecognized directives are ignored. Callers that require no special handling may pass NULL / 0.

18.2.268.6. RETURN VALUE

Returns one of the following:

PMIX_SUCCESS — the encoded representation was expanded and the resulting string returned in output.
PMIX_ERR_INIT — the PMIx library has not been initialized.
PMIX_ERR_BAD_PARAM — regex or output was NULL.

Any other negative value indicates an appropriate error condition. PMIx error constants are defined in pmix_common.h.

18.2.268.7. NOTES

The returned output string is owned by the caller and must be released with free() when no longer needed.