HasArg

The HasArg method indicates whether a specified named argument is present in the command line used to invoke the current extension command.

bool
  ExtExtension::HasArg(
    IN PCSTR  Name
    )

Parameters

Name

Specifies the name of the argument.

Return Value

HasArg returns true if the argument is present; false if it is not present.

Comments

This method will work for all types of named arguments. In particular, it can be used to detect the presence of a named argument of Boolean type.

If the name of the argument is a single character, the convenience method HasCharArg can be used instead.

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

Headers: Defined in Engextcpp.hpp. Include Engextcpp.hpp.

See Also

HasCharArg