Edit

Share via

ExtExtension::SetArgStr method (engextcpp.hpp)

  • Article

The SetArgStr method sets a named string argument for the current expression command.

Syntax

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

Parameters

[in] Name

Specifies the name of the argument. The command-line description used in EXT_COMMAND must specify that the type of this argument is string.

[in] Arg

A string that specifies the value of the named argument. A pointer to the first non-space character is saved as the argument. In this case, Arg must not be NULL.

[in] OnlyIfUnset

Specifies what happens if the argument is already set. If OnlyIfUnset is true and the argument has already been set, the argument will not be changed. If OnlyIfUnset is false and the argument has already been set, the argument will be changed.

Return value

SetArgStr returns true if the argument was changed; false otherwise.

Remarks

For an overview of argument parsing in the EngExtCpp extensions framework, see Parsing Extension Arguments.

This method should only be called during the execution of an extension command provided by this class.

Requirements

Requirement Value
Target Platform Desktop
Header engextcpp.hpp (include Engextcpp.hpp)

See also

EXT_COMMAND

ExtExtension