The
getsubopt() function parses a string containing tokens delimited by one or more tab, space or comma (‘,') characters. It is intended for use in parsing groups of option arguments provided as part of a utility command line.
The argument
optionp is a pointer to a pointer to the string. The argument
tokens is a pointer to a
NULL-terminated array of pointers to strings.
The
getsubopt() function returns the zero-based offset of the pointer in the
tokens array referencing a string which matches the first token in the string, or -1 if the string contains no tokens or
tokens does not contain a matching string.
If the token is of the form ``name=value'', the location referenced by
valuep will be set to point to the start of the ``value'' portion of the token.
On return from
getsubopt(),
optionp will be set to point to the start of the next token in the string, or the null at the end of the string if no more tokens are present. The external variable
suboptarg will be set to point to the start of the current token, or
NULL if no tokens were present. The argument
valuep will be set to point to the ``value'' portion of the token, or
NULL if no ``value'' portion was present.