ExtExtension::SetArg-Methode (engextcpp.hpp)

Artikel
03/05/2024

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 Zeichenfolge ist, wird ein Zeiger auf das erste Leerzeichen als Argument gespeichert. In diesem Fall darf StrArg nicht NULL sein.

Wenn das Argument vom Typ Expression ist, wird StrArg mithilfe des Standardauswertungsauswerters ausgewertet, und der Wert wird zum Wert des Arguments. In diesem Fall kann StrArgNULL sein, und Stattdessen wird NumArg verwendet.

Wenn das Argument vom Typ Boolean ist, wird StrArg ignoriert und kann NULL sein.

[in] NumArg

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

[in] OnlyIfUnset

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

Rückgabewert

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

Hinweise

Eine Übersicht über die Argumentanalyse im EngExtCpp-Erweiterungsframework finden Sie unter Analysieren von Erweiterungsargumenten.

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

Anforderungen

Anforderung	Wert
Zielplattform	Desktop
Kopfzeile	engextcpp.hpp (include Engextcpp.hpp)

Freigeben über