NamedValues.getByIndex Method

Parent Object: NamedValues
Defined in namespace "adsk::core" and the header file is <Core/Application/NamedValues.h>


Function that returns the name and ValueInput object of a name value pair by specifying an index number


"namedValues_var" is a variable referencing a NamedValues object.

(returnValue, name, value) = namedValues_var.getByIndex(index)

#include <Core/Application/NamedValues.h

// Declare the output arguments.
integer index;
string name;
Ptr<ValueInput> value;
boolean returnValue = namedValues_var->getByIndex(index, name, value);

Return Value

Type Description
boolean Returns true if successful


Name Type Description
index integer The index of the name value pair to return. The first pair in the collection has an index of 0.
name string The name
value ValueInput The ValueInput object


Introduced in version August 2014