25.2.225. PMIx_Argv_idx
PMIx_Argv_idx — Find a string in a NULL-terminated
argv-style array of strings.
25.2.225.1. SYNOPSIS
#include <pmix.h>
int PMIx_Argv_idx(char **argv, const char *arg);
25.2.225.1.1. Python Syntax
No Python equivalent
25.2.225.2. INPUT PARAMETERS
argv: Pointer to a NULL-terminated array ofchar *strings, orNULL.arg: The string to look for, orNULL.
25.2.225.3. DESCRIPTION
Walk the argv-style array argv from its first element and return
the position of the first entry whose contents are identical to arg,
as compared by strcmp(3).
A NULL array is treated as an empty one, so a list that is built only
when its first entry is added can be searched before that happens. A
NULL string matches no entry.
Neither the array nor any of its strings is modified. The function does
not allocate memory and does not interact with the PMIx progress thread,
so it is safe to call from any context, including before PMIx_Init.
A caller can tell whether the library provides this function from the
PMIX_CAP_ARGV_IDX capability flag in pmix_version.h.
25.2.225.4. RETURN VALUE
Returns the zero-based index of the first matching entry, or -1 if
there is none - including when argv or arg is NULL.
25.2.225.5. EXAMPLES
char **argv = NULL;
PMIx_Argv_append_nosize(&argv, "alpha");
PMIx_Argv_append_nosize(&argv, "beta");
int n = PMIx_Argv_idx(argv, "beta"); /* n == 1 */
int m = PMIx_Argv_idx(argv, "gamma"); /* m == -1 */
int k = PMIx_Argv_idx(NULL, "alpha"); /* k == -1 */
if (0 <= PMIx_Argv_idx(argv, "alpha")) {
/* "alpha" is present */
}