Edit

Share via

ExtExtension::GetArgU64 method (engextcpp.hpp)

  • Article

The GetArgU64 method returns the value of a named expression argument from the command line used to invoke the current extension command.

Syntax

ULONG64 GetArgU64(
  [in] PCSTR Name,
  [in] bool  Required
);

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] Required

Specifies if the argument is required. If Required is true and the argument was not present on the command line, ExtInvalidArgumentException is called. You do not need to set this parameter; if it is not set Required defaults to true.

Return value

GetArgU64 returns the value of the named expression argument.

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