CB.GetFore

This function retrieves information for a specific forecast cell.

Note:

For best results, call CB.CheckData before calling this function to ensure the latest data values are used.

Table 116. CB.GetFore Returned Data Type

Returned Value

Returned Data Type

The specified forecast data

Variant

Table 117. CB.GetFore Parameters

Parameter

VBA Data Type

Value

Description

ForeReference

Variant

In a macro: Range("B3")

Points to the desired forecast cell

Index

Integer

See Table 118

Retrieves information for a specific forecast cell using the values in Table 118

The following table (Table 118) shows values available for the Index parameter.

Table 118. CB.GetFore Index Parameter Values — Required, Integer

Named Constant Value

Index Value

Description

cbForName

1

Returns the forecast name

cbForUnits

2

Returns the forecast units

cbForAutoOpen

4

Returns whether Crystal Ball displays the forecast window automatically: 0 = no, 1 = yes

cbForOpenWhen

5

Returns when Crystal Ball displays the forecast window: 0 = when running (cbOpnWhenRunning), 1 = when stopped (cbOpnWhenStopped)

cbForPrecision

6

Returns whether Crystal Ball uses precision control: 0 = no, 1 = yes

cbForPrecisionAbsolute

7

Returns what kind of terms Crystal Ball uses to define the confidence interval around the stopping criterion: 0 = relative, 1 = absolute

cbForPrecisionAbsoluteValue

8

Returns the size of the confidence interval in absolute forecast units

cbForPrecisionRelative Value

9

Returns the size of the confidence interval in relative percentage terms

cbForPrecisionMean

10

Returns whether Crystal Ball uses the precision of the mean as a simulation stopping criterion:0 = no, 1 = yes

cbForPrecisionStdDev

11

Returns whether Crystal Ball uses the precision of the standard deviation as a stopping criterion for the simulation: 0 = no, 1 = yes

cbForPrecisionPerc

12

Returns whether Crystal Ball uses the precision of a percentile value as a stopping criterion for the simulation: 0 = no, 1 = yes

cbForPrecisionPercValue

13

Returns the percentile value used to check for the indicated precision

cbForFilter

14

Returns whether Crystal Ball uses forecast filtering: 0 = no, 1 = yes

cbForFilterInside

15

Returns which forecast values Crystal Ball discards in filtering: 0 = the values outside the filtering range, 1 = the values inside the range

cbForFilterFrom

16

Returns the lower bound of the filtering range

cbForFilterTo

17

Returns the upper bound of the filtering range

cbForFilterGlobal

18

Returns whether global filtering is set for the forecast (True) or not (False)

cbForFrozen

19

Returns whether the forecast cell is frozen

cbForLSL

20

Returns a lower specification limit (LSL) for the forecast

cbForUSL

21

Returns an upper specification limit (USL) for the forecast

cbForTarget

22

Returns a target value for the forecast

Note:

The third constant for Index, cbForWindowSize, is obsolete and has been removed from Crystal Ball 7.x and 11.x.