EssGBeginSamplingZoomIn

Description

EssGBeginSamplingZoomIn() begins a sampled zoom-in.

Syntax

ESSG_FUNC_M EssGBeginSamplingZoomIn (hGrid, usCells, pZoomCells, ulSamplingPercentage, ulOptions);
ESSG_HGRID_T hGrid
ESSG_USHORT_T usCells
ESSG_PRANGE_T pZoomCells
ESSG_ULONG_T ulSamplingPercentage
ESSG_ULONG_T ulOptions

Parameters

hGrid Handle passed back from EssGNewGrid.
usCells A count of the number of cell ranges in pZoomCells (the size of array).
pZoomCells Describes the cells to be zoomed in upon. This is a one-dimensional array of cell ranges.
ulSamplingPercentage The percentage sampling rate. This number is an integer between 1 and 100, inclusive. A depth of 100 percent will retrieve all members of the dimension. This effectively turns sampling off and retrieves all members. A ulSamplingPercentage of 50 will retrieve half the members.
ulOptions A bitmask which describes the type of zoom-in (across or down) and the level of the zoom. The following two values are mutually exclusive:
  • ESSG_ZOOM_DOWN   Any page/title dimensions selected will be zoomed down
  • ESSG_ZOOM_ACROSS   Any page dimensions selected will be zoomed across

The following level values are to be or-ed in to ulOptions and are themselves mutually exclusive:

  • ESSG_NEXTLEVEL   Children
  • ESSG_ALLLEVELS   All members
  • ESSG_BOTTOMLEVEL   Bottom level
  • ESSG_SIBLEVEL   Sibling level
  • ESSG_SAMELEVEL   Same level
  • ESSG_SAMEGENERATION   Same generation
  • ESSG_CALCLEVEL   Calculation
  • ESSG_OPTIONS   Use setting for grid options

Return Value

If successful, returns ESSG_STS_NOERR.

Notes

Access

None.

Example



See Also

Using the Grid API Functions
Grid API Structures
EssGBeginZoomIn
EssGBeginConditionalZoomIn