2.9.24 CAPI
The CAPI structure contains information about a caption.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A |
B |
C |
unused1 |
D |
nfc |
||||||||||||||||||||||||||
|
xchSeparator |
|||||||||||||||||||||||||||||||
A - iLocation (2 bits): An unsigned integer that specifies the insert location for the caption. This MUST be one of the following values.
-
Value
Meaning
0x0
Insert the caption below the selected item.
0x1
Insert the caption above the selected item.
B - fChapNum (1 bit): A bit that specifies whether or not to include a chapter number in the caption.
C - iHeading (4 bits): An unsigned integer that specifies which heading style marks the beginning of a new chapter for the purpose of chapter numbering in this caption. This value MUST be one of the following.
|
Value |
Meaning |
|---|---|
|
0x1 |
Heading 1 marks the beginning of a new chapter. |
|
0x2 |
Heading 2 marks the beginning of a new chapter. |
|
0x3 |
Heading 3 marks the beginning of a new chapter. |
|
0x4 |
Heading 4 marks the beginning of a new chapter. |
|
0x5 |
Heading 5 marks the beginning of a new chapter. |
|
0x6 |
Heading 6 marks the beginning of a new chapter. |
|
0x7 |
Heading 7 marks the beginning of a new chapter. |
|
0x8 |
Heading 8 marks the beginning of a new chapter. |
|
0x9 |
Heading 9 marks the beginning of a new chapter. |
-
If fChapNum is zero, this field MUST be ignored.
unused1 (8 bits): This field is undefined and MUST be ignored.
D - fNoLabel (1 bit): A bit that specifies whether or not to include the label in the caption. This bit MAY<205> be ignored.
nfc (2 bytes): An MSONFC, as specified in [MS-OSHARED] section 2.2.1.3, that specifies the formatting of the caption number.
xchSeparator (2 bytes): A Unicode character that specifies the character that separates the chapter number and caption number of the caption. This value MUST be one of the following.
|
Value |
Meaning |
|---|---|
|
0x001E |
A hyphen (-) separates the chapter number and caption number. |
|
0x002E |
A period (.) separates the chapter number and the caption number. |
|
0x003A |
A colon (:) separates the chapter number and the caption number. |
|
0x2013 |
An en-dash (–) separates the chapter number and the caption number. |
|
0x2014 |
An em-dash (—) separates the chapter number and the caption number. |
-
If fChapNum is zero, this value MUST be ignored.