Linux程序员手册 第3部分
更新日期： 2020-06-09

名称

getsubopt-解析字符串中的子选项参数

语法

＃包括

int getsubopt(char ** optionp，char * const * tokens，char ** valuep);

glibc的功能测试宏要求(请参阅feature_test_macros(7))：

getsubopt()：

_XOPEN_SOURCE>= 500 || / *自glibc 2.12起：* / _POSIX_C_SOURCE>= 200809L

说明

getsubopt()解析optionp中提供的逗号分隔子选项的列表。 (此类子选项列表通常在使用getopt(3)解析命令行时产生；例如，请参见mount(8)的-o选项。)每个子选项可能包含一个与子选项名称分开的关联值。等号。以下是可能在optionp中传递的字符串类型的示例：

ro,name=xyz

tokens参数是一个指向以NULL结尾的指针的指针的数组，该指针指向getsubopt()将在optionp中查找的令牌的指针。标记应为不同的，以零结尾的字符串，其中至少包含一个字符，并且没有嵌入的等号或逗号。

每次对getsubopt()的调用都会返回有关optionp中下一个未处理的子选项的信息。子选项(如果有)中的第一个等号被解释为该子选项的名称和值之间的分隔符。该值扩展到下一个逗号，或者(对于最后一个子选项)扩展到字符串的末尾。如果子选项的名称与令牌中的已知名称匹配，并且找到了值字符串，则getsubopt()将* valuep设置为该字符串的地址。 optionp中的第一个逗号被空字节覆盖，因此* valuep恰好是该子选项的"值字符串"。

如果可识别该子选项，但未找到任何值字符串，则* valuep设置为NULL。

当getsubopt()返回时，optionp指向下一个子选项，或者如果刚刚处理了最后一个子选项，则指向字符串末尾的空字节(aq \ 0aq)。

返回值

如果可以识别optionp中的第一个子选项，则getsubopt()返回令牌中匹配的子选项元素的索引。否则，返回-1，* valuep是整个名称[= value]字符串。

由于* optionp已更改，因此在调用getsubopt()之前的第一个子选项与在getsubopt()之后的第一个子选项(不一定)相同。

属性

有关本节中使用的术语的说明，请参见attribute(7)。

遵循规范

POSIX.1-2001，POSIX.1-2008。

备注

由于getsubopt()会覆盖在字符串* optionp中找到的任何逗号，因此该字符串必须可写；它不能是字符串常量。

示例

以下程序期望在" -o"选项之后的子选项。

#define _XOPEN_SOURCE 500
#include <stdlib.h>
#include <assert.h>
#include <stdio.h>

int
main(int argc, char **argv)
{
    enum {
        RO_OPT = 0,
        RW_OPT,
        NAME_OPT
    };
    char *const token[] = {
        [RO_OPT]   = "ro",
        [RW_OPT]   = "rw",
        [NAME_OPT] = "name",
        NULL
    };
    char *subopts;
    char *value;
    int opt;

    int readonly = 0;
    int readwrite = 0;
    char *name = NULL;
    int errfnd = 0;

    while ((opt = getopt(argc, argv, "o:")) != -1) {
        switch (opt) {
        case aqoaq:
            subopts = optarg;
            while (*subopts != aq##代码##aq && !errfnd) {

            switch (getsubopt(&subopts, token, &value)) {
            case RO_OPT:
                readonly = 1;
                break;

            case RW_OPT:
                readwrite = 1;
                break;

            case NAME_OPT:
                if (value == NULL) {
                    fprintf(stderr, "Missing value for "
                            "suboption aq%saq\n", token[NAME_OPT]);
                    errfnd = 1;
                    continue;
                }

                name = value;
                break;

            default:
                fprintf(stderr, "No match found "
                        "for token: /%s/\n", value);
                errfnd = 1;
                break;
            }
        }
        if (readwrite && readonly) {
            fprintf(stderr, "Only one of aq%saq and aq%saq can be "
                    "specified\n", token[RO_OPT], token[RW_OPT]);
            errfnd = 1;
        }
        break;

        default:
            errfnd = 1;
        }
    }

    if (errfnd || argc == 1) {
        fprintf(stderr, "\nUsage: %s -o <suboptstring>\n", argv[0]);
        fprintf(stderr, "suboptions are aqroaq, aqrwaq, "
                "and aqname=<value>aq\n");
        exit(EXIT_FAILURE);
    }

    /* Remainder of program... */

    exit(EXIT_SUCCESS);
}

另外参见

getopt(3)

出版信息

这个页面是Linux手册页项目5.08版的一部分。有关项目的说明、有关报告错误的信息以及此页面的最新版本，请访问https://www.kernel.org/doc/man-pages/。