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

La méthode SetArgStr définit un argument de chaîne nommé pour la commande d’expression actuelle.

Syntaxe

bool SetArgStr(
  [in] PCSTR Name,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

Paramètres

[in] Name

Spécifie le nom de l’argument. La description de ligne de commande utilisée dans EXT_COMMAND doit spécifier que le type de cet argument est string.

[in] Arg

Chaîne qui spécifie la valeur de l’argument nommé. Un pointeur vers le premier caractère autre que l’espace est enregistré en tant qu’argument. Dans ce cas, Arg ne doit pas avoir 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

SetArgStr 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

Voir aussi

EXT_COMMAND

ExtExtension