2.2.3.12.1 ReportData::GetDataRange

Description

Get ReportData's DataRange

Syntax

BOOL GetDataRange( DataRange & dr, int nTableID, int nIDX, int * pnIDY, int nCountIDY = 1, BOOL bMultipleBlocks = TRUE, BOOL bCreateWks = false, BOOL bIgnoreRowRange = FALSE, BOOL bCheckConvertUpperbound = FALSE )

Parameters

dr

[output] The Datarange that receives the datarange. You may also passing derived classes like XYRange

nTableID

[input] id of table associated with the range

nIDX

[input] id of X column of the range. Use 0 if no X column

pnIDY

[input] id(s) of Y column(s) of the range. Use NULL if no Y column

nCountIDY

[input] the number of Y column id

bMultipleBlocks

[input] if TRUE range will be constructed as XYXY.., otherwise XYY..

bCreateWks

[input] if TRUE and no associated worksheet, create one

bIgnoreRowRange

[input] if TRUE range will have no row range

bCheckConvertUpperbound

[input] Takes effect when bIgnoreRowRange = FALSE. If TRUE it will try to convert row range to full range when it's possible

Return

TRUE for success; otherwise FALSE.

Examples

ReportBase's examples

Remark

Get one data range by ids from the report

See Also

Header to Included

ReportTree.h