Edit

Share via

ExtExtension::SetUnnamedArgU64 method (engextcpp.hpp)

  • Article

The SetUnnamedArgU64 method sets the value of an unnamed expression argument for the current extension command.

Syntax

bool SetUnnamedArgU64(
  [in] ULONG   Index,
  [in] ULONG64 Arg,
  [in] bool    OnlyIfUnset
);

Parameters

[in] Index

Specifies the index of the argument. The command-line description used in EXT_COMMAND must specify that the type of this argument is expression. Index should be between zero and the number of unnamed arguments - as specified in the command-line description used in EXT_COMMAND - minus one.

[in] Arg

Specifies the value of an unnamed 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

SetUnnamedArgU64 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