ExtExtension::GetUnnamedArgStr method (engextcpp.hpp)

Article
02/22/2024

The GetUnnamedArgStr method returns an unnamed string argument from the command line used to invoke the current extension command.

Syntax

PCSTR GetUnnamedArgStr(
  [in] ULONG Index
);

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 string. The value of Index should be between zero and the number of unnamed arguments returned by GetNumUnnamedArgs minus one (unnamed arguments - 1).

Return value

GetUnnamedArgStr returns the unnamed string argument.

Remarks

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

The string returned by GetUnnamedArgStr is only meaningful during the execution of the current extension command.

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)

Share via