ExtExtension::SetArg-Methode (engextcpp.hpp)

Die SetArg--Methode legt ein benanntes Argument für den aktuellen Erweiterungsbefehl fest.

Syntax

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

Parameter

[in] Name

Gibt den Namen des Arguments an.

[in, optional] StrArg

Eine Zeichenfolge, die den Wert des benannten Arguments angibt.

Wenn das Argument vom Typ Zeichenfolgeist, wird ein Zeiger auf das erste Nicht-Leerzeichen als Argument gespeichert. In diesem Fall darf StrArg- nicht NULL-sein.

Wenn das Argument vom Typ Ausdrucksist, wird StrArg mithilfe des Standardausdruck-Evaluators ausgewertet, und der Wert wird zum Wert des Arguments. In diesem Fall kann StrArg-NULL- sein und stattdessen NumArg- verwendet werden.

Wenn das Argument vom Typ booleschenist, wird StrArg ignoriert und kann NULL-werden.

[in] NumArg

Gibt den Wert eines benannten Ausdrucksarguments an. NumArg- wird nur verwendet, wenn der Typ des Arguments ein Ausdruck ist und StrArg-NULL-ist.

[in] OnlyIfUnset

Gibt an, was passiert, wenn das Argument bereits festgelegt ist. Wenn OnlyIfUnset-true ist und das Argument bereits festgelegt wurde, wird das Argument nicht geändert. Wenn OnlyIfUnset-false ist und das Argument bereits festgelegt wurde, wird das Argument geändert.

Rückgabewert

SetArg- gibt true zurück, wenn das Argument geändert wurde; andernfalls false.

Bemerkungen

Eine Übersicht über die Argumentanalyse im EngExtCpp-Erweiterungsframework finden Sie unter Parsing Extension Arguments.

Diese Methode sollte nur während der Ausführung eines Erweiterungsbefehls aufgerufen werden, der von dieser Klasse bereitgestellt wird.

Anforderungen