CB.GetBatchFitOption

This function returns specified settings made by CB.BatchFitND or the Batch Fit tool.

Table 89. CB.GetBatchFitOption Returned Data Type

Returned Value	Returned Data Type
The specified Batch Fit settings	Variant

Table 90. CB.GetBatchFitOption Parameters — Required, Integer

Parameter	Required?	VBA Data Type	Table
Index	Required	Integer	Table 91
Value1	Optional	Variant	Table 92
Value2	Optional	Variant	Table 93

Table 91. CB.GetBatchFitOption Index Parameter — Required, Integer

Named Constant Value	Index Value	Description
cbBftInputRange	1	Returns a string with the address of the selected Batch Fit data range in the format: '[workbook]sheet'!$A$1:$Z$100
cbBftInputOrientation	2	Returns a constant to indicate whether the data cells are in rows or columns: cbBftInputRows [1] or cbBftInputColumns [2]
cbBftInputHeader	3	Returns a boolean to indicate whether the input range has a header (True)
cbBftInputLabel	4	Returns a boolean to indicate whether the input range has a label (True)
cbBftSelectDist	5	Returns an array of cbDfa... assumption distribution integers as listed in Table 53
cbBftRankMethod	11	Returns the constant of the selected fit ranking method as listed in Table 78
cbBftOutputLocation	12	Returns the constant of the selected output location setting, a new workbook, the current workbook, a new worksheet, or the current worksheet: cbBftNewWorkbook [1], cbBftCurrentWorkbook [2], cbBftNewWorksheet [3], or cbBftCurrentWorksheet [4] If cbBftCurrentWorksheet is returned, you can use cbBftOutputLocationCell [25] to return the starting cell.
cbBftOutputFormat	13	Returns a boolean to indicate whether the output is formatted (True)
cbBftOutputCorrelationMatrix	14	Returns a boolean to indicate whether a correlation matrix is produced (True)
cbBftOutputCorrelation	15	Returns a boolean to indicate whether assumptions greater than a certain absolute value threshold are correlated (True); if True, use cbBftOutputCorrelationThreshold [26] to return the threshold value
cbBftLinkToCorrelationMatrix	16	Returns a boolean to indicate whether there is a link to the matrix of correlations between the data series (True), assuming cbBftOutputCorrelationMatrix [14] is set to True
cbBftOutputGoodnessOfFitReport	17	Returns a boolean to indicate whether a goodness-of-fit report is produced (True); if True, use cbBftOutputGoodnessOfFitSheet [27] to return the sheet name of the report
cbBftOutputAssumReport	18	Returns a boolean to indicate whether an assumption report is produced (True); if True, use cbBftOutputAssumSheet [28] to return the sheet name of the report
cbBftOutputAssumFullStatistics	19	If cbBftOutputAssumReport [18] is True, can be used to return a boolean to indicate whether the assumption report includes full statistics (True)
cbBftUseDistLocking	21	Returns a boolean to indicate whether parameter locking is switched on (True)
cbBftOutputGoodnessOfFitAllStats	22	Returns a boolean to indicate whether all statistics should appear when a Goodness of Fit report is produced (True)
cbBftFitDistLockParam	23	Returns the locked value of the specified distribution and parameter. The following distributions from Table 53 can be used as Value1: Gamma distribution — Location, Shape parameters Lognormal distribution — Location parameter Student's t distribution — Degrees of Freedom parameter Weibull distribution — Location, Shape parameters Binomial distribution — Trials parameter Hypergeometric distribution — Trials parameter Use Value2 to specify the number of the target parameter.
cbBftOutputLocationCell	25	If cbBftOutputLocation [12] returns cbBftCurrentWorksheet [4], can be used to return the first cell of the output range (in the upper left corner)
cbBftOutputCorrelationThreshold	26	If cbBftOutputCorrelation [15] returns True, can be used to return the correlation threshold absolute value (default = 0.0)
cbBftOutputGoodnessOfFitSheet	27	If cbBftOutputGoodnessOfFitReport [17] returns True, can be used to return the sheet name string of the report
cbBftOutputAssumSheet	28	If cbBftOutputAssumReport [18] returns True, can be used to return the sheet name string of the report
cbBftOutputWorksheet	29	Returns whether the current sheet (cbBftCurrentWorksheet [4]) or new sheet (cbBftNewWorksheet [3]) is being used for the Batch Fit output
cbBftOutputOrientation	30	Returns a constant to indicate whether the output is in rows or columns: cbBftOutputRows [1] or cbBftOutputColumns [2]
cbBftOutputSheetName	31	Returns the name of the worksheet containing primary fit results (assumptions) as a string

Table 92. CB.GetBatchFitOption Value1 Parameter — Optional, Variant

Used With Specified Values of Index	Named Constant or Boolean Value	Index Value	Description
For Index = 23, cbBftFitDistLockParam: Variant	One of the cbDfa[distribution]... names for the following distributions from Table 53: gamma, lognormal, Student’s t, Weibull, binomial, hypergeometric.	n/a	Returns the locked value of the specified distribution and the parameter specified with Value2

Table 93. CB.GetBatchFitOption Value2 Parameter — Optional, Variant

Used With Specified Values of Index	Named Constant or Boolean Value	Index Value	Description
For Index = 23, cbBftFitDistLockParam: Integer	One of the parameter numbers from Table 53 for the distribution specified with Value1: gamma, lognormal, Student’s t, Weibull, binomial, hypergeometric.	n/a	Returns the locked value of the specified parameter for the distribution specified with Value1. The numbers listed for the following parameters in Table 53 can be used for Value2: Gamma distribution — Location, Shape parameters Lognormal distribution — Location parameter Student's t distribution — Degrees of Freedom parameter Weibull distribution — Location, Shape parameters Binomial distribution — Trials parameter Hypergeometric distribution — Trials parameter