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

La méthode GetArgStr retourne un argument de chaîne nommé à partir de la ligne de commande utilisée pour appeler la commande d’extension actuelle.

Syntaxe

PCSTR GetArgStr(
  [in] PCSTR Name,
  [in] bool  Required
);

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] Required

Spécifie si l’argument est requis. Si Obligatoire est true et que l’argument n’était pas présent sur la ligne de commande, ExtInvalidArgumentException est levée. Vous n’avez pas besoin de définir ce paramètre ; s’il n’est pas défini par défaut Obligatoire sur true.

Valeur retournée

GetArgStr retourne l’argument de chaîne nommé.

Remarques

Pour obtenir une vue d’ensemble de l’analyse des arguments dans l’infrastructure des extensions EngExtCpp, consultez Analyse des arguments d’extension.

La chaîne retournée par GetArgStr n’est significative que pendant l’exécution de la commande d’extension actuelle.

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