2.4.255 BrtBeginSXPI

The BrtBeginSXPI record specifies properties of a pivot field (section 2.2.5.3.2) or pivot hierarchy (section 2.2.5.3.4) on the page axis (section 2.2.5.3.7.1) of the PivotTable view (section 2.2.5.3) and specifies the beginning of an empty collection of records as defined by the PivotTable (section 2.1.7.40) part ABNF. The collection of records specifies a pivot field or pivot hierarchy (section 2.2.5.3.4) on the page axis (section 2.2.5.3.7.1) of the PivotTable view.


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

isxvd

isxvi

isxth

A

B

reserved

irstUnique (variable)

...

irstDisplay (variable)

...

isxvd (4 bytes):  An ISXVD (section 2.5.84) that specifies a pivot field that is displayed on the page axis area of the PivotTable view. This value MUST NOT equal -1 or -2. The value of the sxaxisPage of the sxaxis field of the referenced BrtBeginSXVD record (section 2.4.272) MUST be equal to 1.

isxvi (4 bytes): An unsigned integer that specifies the pivot item (section 2.2.5.3.3) included in the filter for this pivot field. This value MUST be a value from the following table.

Value

Meaning

0x00000000 to 0x00100000

Specifies a pivot item index, as specified in section 2.2.5.3.3, for the pivot item included in the filter, as specified by Non-OLAP Page Filtering (section 2.2.5.3.7.1.1).

0x001000FE

Specifies that pivot items are included as specified in sections 2.2.5.3.7.1.1 (Non-OLAP Page Filtering) and section 2.2.5.3.7.1.2 (OLAP Page Filtering).

If this field is not equal to 0x001000FE, then the fEnableMultiplePageItems field in the BrtBeginSXVD record of the pivot field specified by isxvd MUST be equal to 0. If the fEnableMultiplePageItems field in the BrtBeginSXVD record of the pivot field specified by isxvd is equal to 1, this field MUST be equal to 0x001000FE. If this is an OLAP PivotTable view, this field MUST be equal to 0x001000FE.

isxth (4 bytes):  An ISXTH (section 2.5.83) that specifies the pivot hierarchy to which the pivot field specified by isxvd belongs. If this PivotTable is an OLAP PivotTable, this field MUST NOT be equal to -1 or -2. If this PivotTable is not an OLAP PivotTable, this value MUST be ignored.

A - fUnique (1 bit):  A bit that specifies whether irstUnique is present after the fixed-length portion of this record. This value MUST be equal to 0 for PivotTables that are not OLAP PivotTables.

B - fDisplay (1 bit):  A bit that specifies whether irstDisplay is present after the fixed-length portion of this record. This value MUST be equal to 0 for PivotTables that are not OLAP PivotTables.

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

irstUnique (variable):  An XLWideString (section 2.5.169) that specifies the MDX unique name of an OLAP member. If the fEnableMultiplePageItems field on the BrtBeginSXTH (section 2.4.263) record specified by this record's isxth field is equal to 0, the OLAP member specified by this field is included in the manual filter (section 2.2.5.3.5).

If the irstUnique field is present and the bVerCacheCreated field on the BrtBeginPivotCacheDef (section 2.4.168) record associated with this PivotTable view is less than 3, then this string MUST be less than or equal to 255 characters in length. If the bVerCacheCreated field of that BrtBeginPivotCacheDef record associated with this PivotTable view is greater than or equal to 3, then this string MUST be less than or equal to 32,767 characters in length.

If the fUnique field is 1, this irstUnique field MUST be present. If the fUnique field is 0, this irstUnique field MUST NOT be present. If the fEnableMultiplePageItems field on the BrtBeginSXTH record specified by this record's isxth field is equal to 1, this field MUST be ignored.

irstDisplay (variable):  An XLWideString that specifies the caption of the OLAP member specified by this record's irstUnique field when the fEnableMultiplePageItems field on the BrtBeginSXTH record specified by this record's isxth field is equal to 0.

If the irstDisplay field is present and the bVerCacheCreated field on the BrtBeginPivotCacheDef record associated with this PivotTable view is less than 3, then this string MUST be less than or equal to 255 characters in length. If the bVerCacheCreated field of that BrtBeginPivotCacheDef record associated with this PivotTable view is greater than or equal to 3, then this string MUST be less than or equal to 32,767 characters in length.

If the fDisplay field is 1, this irstDisplay field MUST be present. If the fDisplay field is 0, this irstDisplay field MUST NOT be present. If the fEnableMultiplePageItems field on the BrtBeginSXTH record specified by this record's isxth field is equal to 1, this field MUST be ignored.