System.AutoCmd.GetNamedParm

From RAD Studio API Documentation
Jump to: navigation, search

C++

Variant&          GetNamedParm(const Byte idx);

Properties

Type Visibility Source Unit Parent
function public sysvari.h System AutoCmd

Description

Returns the value of a named parameter.

Call GetNamedParm to determine the value of a named parameter that was assigned using the << operator. The value is returned as a Variant object. Its underlying type can be obtained using the GetNamedArgType method.

The idx parameter is the index of the value in the AutoCmd object’s named parameter list, where 0 is the index of the first argument. Use the GetNamedArgCount method to obtain an upper limit of possible values.

See Also