Edit

Share via

ExtExtension::SetArgU64 method (engextcpp.hpp)

  • Article

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

Syntax

bool SetArgU64(
  [in] PCSTR   Name,
  [in] ULONG64 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 expression.

[in] Arg

Specifies the value of the named expression argument.

[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

SetArgU64 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