Méthode ExtExtension ::SetUnnamedArg (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. L’index doit être compris entre zéro et le nombre d’arguments sans nom, comme spécifié dans la description de ligne de commande utilisée dans EXT_COMMAND, moins un (arguments sans nom - 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 autre que l’espace est enregistré en tant qu’argument. Dans ce cas, StrArg ne doit pas avoir la valeur NULL.

Si l’argument est d’expression de type, 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 Boolean, 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 d’expression de type et StrArg a la valeur 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 retournée

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 des extensions EngExtCpp, consultez Analyse des arguments d’extension.

Cette méthode doit être appelée uniquement pendant l’exécution d’une commande d’extension fournie par cette classe.

Configuration requise

Voir aussi

EXT_COMMAND

ExtExtension