2.4.154 BrtBeginPCDSCSet

The BrtBeginPCDSCSet record specifies properties of a range of the source data (section 2.2.5.2.1) for a multiple consolidation ranges (section 2.2.5.2.1.1) PivotCache (section 2.2.5.2) and specifies the beginning of an empty collection of records as defined by the PivotCache Definition (section 2.1.7.38) part ABNF. The range is either in this workbook or another workbook.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

rgiItem (16 bytes)

...

...

fName

fBuiltIn

A

B

reserved2

irstSheet (variable)

...

irstRelId (variable)

...

rfx (16 bytes, optional)

...

...

irstName (variable)

...

rgiItem (16 bytes):  An array of 4-byte unsigned integers. Each element of the array specifies an index to a value for a cache item (section 2.2.5.2.3) of a cache field (section 2.2.5.2.2) for a multiple consolidation ranges (section 2.2.5.2.1.1) PivotCache associated with this range. Each element of the array specifies a zero-based index to a BrtBeginPCDSCPItem (section 2.4.153) record in the BrtBeginPCDSCPage collection following the BrtBeginPCDSConsol (section 2.4.154) collection that precedes this record.

The first element in this array corresponds to the first BrtBeginPCDSCPage collection in the BrtBeginPCDSCPages (section 2.4.152) collection following the BrtBeginPCDSConsol collection that precedes this record.

The second element in this array corresponds to the second BrtBeginPCDSCPage collection (section 2.4.151) in the BrtBeginPCDSCPages collection following the BrtBeginPCDSConsol collection that precedes this record.

The third element in this array corresponds to the third BrtBeginPCDSCPage collection in the BrtBeginPCDSCPages collection following the BrtBeginPCDSConsol collection that precedes this record.

The fourth element in this array corresponds to the fourth BrtBeginPCDSCPage collection in the BrtBeginPCDSCPages collection following the BrtBeginPCDSConsol collection that precedes this record.

If the number of BrtBeginPCDSCPage collections in the BrtBeginPCDSCPages collection is less than four, the value for each array element that does not have a corresponding BrtBeginPCDSCPage collection MUST be 0xFFFFFFFF. If the BrtBeginPCDSCPage collection corresponding to an array element has no following BrtBeginPCDSCPItem (section 2.4.153) records, the value of that array element MUST be 0xFFFFFFFF. The value of each array element MUST be either greater than or equal to 0 and less than the number of BrtBeginPCDSCPItem records in the BrtBeginPCDSCPage collection following the BrtBeginPCDSConsol collection that precedes this record, or MUST be 0xFFFFFFFF if no BrtBeginPCDSCPItem record is specified. For more details, see section 2.2.5.2.1.1.

fName (1 byte): A Boolean (section 2.5.98.3) that specifies whether the range is specified by irstName or rfx. This value MUST be a value from the following table:

Value

Meaning

0x00

The range is specified by rfx. The irstName field MUST NOT be present. The rfx field MUST be present. The value of fLoadSheet MUST be 1.

0x01

The range is specified by irstName. The irstName field MUST be present. The rfx field MUST NOT be present.

fBuiltIn (1 byte): A Boolean that specifies whether the defined name specified by the irstName field refers to a built-in name or a user-defined name. This value MUST be a value from the following table:

Value

Meaning

0x00

irstName specifies a user-defined name.

0x01

irstName specifies a built-in name.

If the value of fName is 0x00, this value MUST be 0x00.

A - fLoadRelId (1 bit): A bit that specifies whether irstRelId exists.

B - fLoadSheet (1 bit): A bit that specifies whether irstSheet exists.

reserved2 (6 bits): This value MUST be 0, and MUST be ignored.

irstSheet (variable): An XLWideString (section 2.5.169) that specifies the name of the sheet in which the range is located. The length of the string MUST be greater than or equal to 1, and less than or equal to 31. This field MUST exist when fLoadSheet is equal to 1, and MUST NOT exist when fLoadSheet is equal to 0.

irstRelId (variable): A RelID (section 2.5.115) that specifies a path to another workbook that contains the range. This field MUST exist when fLoadRelId is equal to 1, and MUST NOT exist when fLoadRelId is equal to 0.

rfx (16 bytes): An UncheckedRfX (section 2.5.154) that specifies a range that is part of the source data for a multiple consolidation ranges (section 2.2.5.2.1.1) PivotCache. This field MUST exist when fName is equal to 0, and MUST NOT exist when fName is equal to 1.

irstName (variable): An XLWideString that specifies the defined name that is part of the source data for a multiple consolidation ranges PivotCache. The length of this string MUST be greater than or equal to 1, and less than or equal to 255. This field MUST exist when fName is equal to 1, and MUST NOT exist when fName is equal to 0.