2.4.244 SCENARIO

The SCENARIO record specifies a scenario.


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

cref

fLocked

fHidden

cchName

cchComment

cchNameUser

rgchName (variable)

...

rgchNameUser (variable)

...

rgchComment (variable)

...

rgSLC (variable)

...

rgst (variable)

...

unused (variable)

...

cref (2 bytes):  An unsigned integer that specifies the number of cells in the scenario. MUST be greater than zero and less than or equal to 32.

fLocked (1 byte):  A Boolean (section 2.5.14) that specifies whether the scenario can be modified if the workbook is protected.  It MUST be a value from the following table: 

Value

Meaning

0x00

The user can change the scenario.

0x01

When the workbook is protected, the user cannot change the scenario.

fHidden (1 byte):  A Boolean that specifies whether the scenario is to be hidden from the user if the workbook is protected.  It MUST be a value from the following table:

Value

Meaning

0x00

The scenario is never hidden

0x01

When the workbook is protected, the scenario is hidden from the user.

cchName (1 byte):  An unsigned integer that specifies the character count in the field rgchName.

cchComment (1 byte):  An unsigned integer that specifies the character count in the field rgchComment.

cchNameUser (1 byte):  An unsigned integer that specifies the character count in the field rgchNameUser.

rgchName (variable):  An XLUnicodeStringNoCch structure that specifies the name of the scenario. 

rgchNameUser (variable):  An XLUnicodeString structure that specifies the name of the user who created the scenario. The character count MUST be less than or equal to 52. MUST be omitted if cchNameUser is 0.

rgchComment (variable):  An XLUnicodeString structure that specifies a comment associated with the scenario. MUST be omitted if cchComment is 0.

rgSLC (variable): An array of SLCO8 structures.  Each element of the array specifies one cell that is changed by the scenario.  Its element count MUST be cref.

rgst (variable): An array of XLUnicodeString structures. Each element of the array specifies the value associated to a cell by the scenario. Its element count MUST be cref.

unused (variable): Undefined and MUST be ignored.  The size of this field in bytes MUST be 2*cref.