Langage de programmation - GNU C - Référence de procédures et de fonctions

ARGP_PARSE	Analyseur d'argument : Analyseur
GNU C	argp.h

error_t argp_parse(const struct argp *argp, int argc, char **argv, unsigned flags, int *arg_index, void *input);

Nom	Description
argp	Ce paramètre permet d'indiquer l'analyseur de paramètres.
argc	Ce paramètre permet d'indiquer le nombre de paramètres.
argv	Ce paramètre permet d'indiquer les paramètres.
flags	Ce paramètre permet d'indiquer les drapeaux d'options.
arg_index	Ce paramètre permet d'indiquer une valeur.
input	Ce paramètre permet d'indiquer l'entrée transmise à l'analyseur argp.

Cette fonction permet d'analyser les paramètres dans argv et de longueur argc en utilisant argp pour l'analyser.

La fonction argp_parse analyse les paramètres dans argv, de longueur argc, à l'aide de l'analyseur argp avec le paramètre argp. Passer un pointeur null pour argp revient à utiliser une struct argp contenant tous les zéros. Le paramètre flags est un ensemble de bits de drapeau modifiant le comportement d'analyse. Le paramètre input est transmise à l'analyseur argp par le paramètre argp et sa signification est définie par argp. Une utilisation typique consiste à passer un pointeur sur une structure étant utilisée pour spécifier des paramètres à l'analyseur et renvoyer les résultats.
Sauf si les drapeaux ARGP_NO_EXIT ou ARGP_NO_HELP sont inclus dans les drapeaux, l'appel à la fonction argp_parse peut entraîner la fermeture du programme. Ce comportement est vrai si une erreur est détectée ou lorsqu'une option inconnue est rencontrée.
Si le paramètre arg_index n'est pas nul, l'arg_index de la première option non analysée dans argv est renvoyé en tant que valeur.
La valeur de retour est zéro pour une analyse réussie, ou un code d'erreur si une erreur est détectée. Différents analyseurs argp peuvent renvoyer des codes d'erreur arbitraires, mais les codes d'erreur standard sont : ENOMEM si une erreur d'allocation de mémoire s'est produite, ou EINVAL si une option ou un paramètre d'option inconnu est rencontré.

Dernière mise à jour : Mardi, le 19 Mai 2020

Section courante