2.4.711 BrtName
The BrtName record specifies a defined name.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A |
B |
C |
D |
E |
F |
fgrp |
G |
H |
I |
reserved |
|||||||||||||||||||||
|
chKey |
itab |
||||||||||||||||||||||||||||||
|
... |
name (variable) |
||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
formula (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
comment (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
unusedstring1 (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
description (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
helpTopic (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
unusedstring2 (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
A - fHidden (1 bit): A bit that specifies whether the defined name is not visible in the list of defined names.
B - fFunc (1 bit): A bit that specifies whether the defined name represents an XLM macro. If this bit is 1, then fProc MUST also be 1.
C - fOB (1 bit): A bit that specifies whether the defined name represents a Visual Basic for Applications (VBA) macro. If this bit is 1, then fProc MUST also be 1.
D - fProc (1 bit): A bit that specifies whether the defined name represents a macro.
E - fCalcExp (1 bit): A bit that specifies whether formula.rgce contains a call to a function that can return an array.
F - fBuiltin (1 bit): A bit that specifies whether the defined name represents a built-in name.
fgrp (9 bits): An FnGroupID (section 2.5.52) that specifies the function category for the defined name. This value MUST be less than iMac field of BrtBeginFnGroup (section 2.4.88) plus the count of BrtFnGroup (section 2.4.682) records. If fProc is 0, then the value MUST be 0 and MUST be ignored.
G - fPublished (1 bit): A bit that specifies whether the defined name was published.
H - fWorkbookParam (1 bit): A bit that specifies whether the defined name is a workbook parameter.
I - fFutureFunction (1 bit): A bit that specifies whether the defined name is a future function. fFutureFunction MUST be 0 if one of the following conditions is TRUE: fHidden is 0, fFunc is 0, fOB is 1, fProc is 0, fCalcExp is 1, fgrp is not 0, fPublished is 1, fBuiltin is 1, fWorkbookParam is 1, comment.cchCharacters is not 0xFFFFFFFF, or itab is not 0xFFFFFFFF.
reserved (14 bits): This value MUST be 0, and MUST be ignored.
chKey (1 byte): The unsigned integer value of the ASCII character that specifies the shortcut key for the macro represented by the defined name. This value MUST be 0 if fFunc is 1 or if fProc is 0. Otherwise MUST be greater than or equal to 0x20.
itab (4 bytes): An unsigned integer that specifies the scope of the defined name. This value MUST be a value from the following table.
|
Value |
Meaning |
|---|---|
|
0xFFFFFFFF |
The scope is entire workbook. |
|
Greater than or equal to 0 and less than 0xFFFFFFFF |
Specifies a zero-based index of a BrtBundleSh (section 2.4.313) record in the collection of all records directly following BrtBeginBundleShs (section 2.4.13). The referenced BrtBundleSh specifies the scope of the defined name. |
name (variable): An XLNameWideString (section 2.5.166) that specifies the name of the defined name. If fFutureFunction is 1, name MUST be equal to one of the values in the Future Function table in Ftab (section 2.5.98.10).
-
If fFutureFunction is 0, name MUST NOT be equal to one of the values in the Future Function table in Ftab.
formula (variable): A NameParsedFormula (section 2.5.98.12) that specifies the formula (section 2.2.2) for the defined name. If fFutureFunction is 1, formula.rgce MUST consist of a single PtgErr (section 2.5.98.39) with a err equal to 0x1D.
comment (variable): An XLNullableWideString (section 2.5.167) that specifies the comment for the defined name. The length of this string MUST be less than 256 characters.
unusedstring1 (variable): An XLNullableWideString that MUST be a NULL string and MUST be ignored. This value MUST exist if and only if fProc is 1.
description (variable): An XLNullableWideString that specifies the custom menu for the macro represented by the defined name. This value MUST exist if and only if fProc is 1. The length of this string MUST be less than 32768 characters.
helpTopic (variable): An XLNullableWideString that specifies the description for the macro represented by the defined name. This value MUST exist if and only if fProc is 1. The length of this string MUST be less than 32768 characters.
unusedstring2 (variable): An XLNullableWideString that MUST be a NULL string and MUST be ignored. This value MUST exist if and only if fProc is 1.