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

La méthode SetUnnamedArgStr définit un argument de chaîne sans nom pour la commande d’extension actuelle.

Syntaxe

bool SetUnnamedArgStr(
  [in] ULONG Index,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

Paramètres

[in] Index

Spécifie l’index 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. L’index doit être compris entre zéro et le nombre d’arguments sans nom ( tel que spécifié dans la description de ligne de commande utilisée dans EXT_COMMAND - moins un.

[in] Arg

Chaîne qui spécifie la valeur de l’argument sans nom. Un pointeur vers le premier caractère autre que l’espace est enregistré en tant qu’argument.

[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

SetUnnamedArgStr 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