ExtExtension ::SetArg, méthode (engextcpp.hpp)

La méthode SetArg définit un argument nommé pour la commande d’extension actuelle.

Syntaxe

bool SetArg(
  [in]           PCSTR   Name,
  [in, optional] PCSTR   StrArg,
  [in]           ULONG64 NumArg,
  [in]           bool    OnlyIfUnset
);

Paramètres

[in] Name

Spécifie le nom de l’argument.

[in, optional] StrArg

Chaîne qui spécifie la valeur de l’argument nommé.

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 devient la valeur de l’argument. Dans ce cas, StrArg peut être NULL et NumArg est utilisé à la place.

Si l’argument est de type Boolean, StrArg est ignoré et peut avoir la valeur NULL.

[in] NumArg

Spécifie la valeur d’un argument d’expression nommée. NumArg est utilisé uniquement si le type de l’argument est une expression et si 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

SetArg 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 ne doit être appelée que pendant l’exécution d’une commande d’extension fournie par cette classe.

Configuration requise