Contents Previous Next


ArgName Property (BDKDistribution Object)

Description

Returns the name of a "standard" distribution argument. The "standard" arguments are all the required arguments of the distribution, excluding optional shift factors.

Syntax

object.ArgName(argIndex as Integer, Optional symbolFormat as Boolean = False)

Arguments

argIndex (Required Integer) – the index of the "standard" argument to retrieve the name for. The first argument index is one.

symbolFormat (Optional Boolean) – several BestFit arguments are greek symbols. If symbolFormat is FALSE (the Default value) these greek names are spelled out in English. If symbolFormat is TRUE, however, all greek arguments start with a slash (/) character and the subsequent characters should be formatted using the Windows symbol font.

Return Value

(String) – the name of the argument

Example

'Get the name of the first argument:
theArgName = dist.ArgName(1)