ExtExtension ::SetUnnamedArg, méthode (engextcpp.hpp)
La méthode SetUnnamedArg définit un argument sans nom pour la commande d’extension actuelle.
Syntaxe
bool SetUnnamedArg(
[in] ULONG Index,
[in, optional] PCSTR StrArg,
[in] ULONG64 NumArg,
[in] bool OnlyIfUnset
);
Paramètres
[in] Index
Spécifie l’index de l’argument. 'index doit être compris entre zéro et le nombre d’arguments non nommés, comme spécifié dans la description de ligne de commande utilisée dans EXT_COMMAND, moins un (arguments non nommés - 1).
[in, optional] StrArg
Chaîne qui spécifie la valeur de l’argument sans nom.
Si l’argument est de type chaîne, un pointeur vers le premier caractère non espace est enregistré en tant qu’argument. Dans ce cas, StrArg ne doit pas être NULL.
Si l’argument est de type expression, StrArg est évalué à l’aide de l’évaluateur d’expression par défaut et la valeur retournée par l’évaluateur d’expression par défaut devient la valeur de l’argument. Dans ce cas, StrArg peut être NULL et NumArg doit être utilisé à la place.
Si l’argument est de type booléen, StrArg est ignoré et peut être NULL.
[in] NumArg
Spécifie la valeur d’un argument d’expression sans nom. NumArg est utilisé uniquement si l’argument est de type expression et StrArg est NULL.
[in] OnlyIfUnset
Spécifie ce qui se passe si l’argument est déjà défini. Si OnlyIfUnset est true et que l’argument a déjà été défini, l’argument n’est pas modifié. Si OnlyIfUnset est false et que l’argument a déjà été défini, l’argument est modifié.
Valeur de retour
SetUnnamedArg retourne true si l’argument a été modifié ; false sinon.
Remarques
Pour obtenir une vue d’ensemble de l’analyse des arguments dans l’infrastructure d’extensions EngExtCpp, consultez analyse des arguments d’extension.
Cette méthode ne doit être appelée que pendant l’exécution d’une commande d’extension fournie par cette classe.
Exigences
| Exigence | Valeur |
|---|---|
| plateforme cible | Bureau |
| d’en-tête | engextcpp.hpp (include Engextcpp.hpp) |