3.1 Example of a Clx

The following is an example of a Clx. This structure demonstrates the mapping between CP elements and the location of text in the file. See section 2.4.1, Retrieving Text.

Figure 3: Portions of the FibRgFcLcb97 structure, with emphasis on fcClx and lcbClx

As with all Word Binary files, this file has a Fib at an offset of zero in the WordDocument Stream. The preceding figure shows a portion of the FibRgFcLcb97 that is contained in that Fib. The FibRgFcLcb97 is very large. Most fields have been omitted here, for brevity.

fcClx: 0x000001F8 specifies the offset, in bytes, of a location in the Table Stream. A Clx begins at this offset.

lcbClx: 0x0000002D specifies the size, in bytes, of the Clx at offset 0x000001F8 in the Table Stream.

The following shows the top level of the Clx at offset 0x000001F8 in the Table Stream.

Figure 4: A Clx structure

RgPrc: This optional member is not present in this Clx structure. Because the first byte of this Clx structure is 0x02, the Clx begins with a Pcdt structure and does not contain an array of Prc structures.

Pcdt.clxt: 0x02 specifies that this is a Pcdt structure, as opposed to a Prc structure.

Pcdt.lcb: 0x00000028 specifies the size, in bytes, of PlcPcd. A PlcPcd is a Plc structure whose data members are Pcd structures. A Pcd is 8 bytes in size, so this PlcPcd consists of three Pcd structures and four CP elements.

The following shows the top-level expansion of the PlcPcd that is contained in this Clx. The Pcd structures, which are expanded in later tables, specify the locations of text in the file.

Figure 5: The top-level expansion of a PlcPcd

cp[0]: 0x00000000 specifies that pcd[0] applies to text starting at CP zero. Because cp[1] is 0x0000006, pcd[0] applies to CP values zero through 5, inclusive.

cp[1]: 0x00000006 specifies that pcd[1] applies to text starting at CP 0x00000006. Because cp[2] is 0x0000000D, pcd[1] applies to CP values 0x00000006 through 0x0000000C, inclusive.

cp[2]: 0x0000000D specifies that pcd[2] applies to text starting at CP 0x0000000D. Because cp[3] is 0x0000000E, pcd[2] applies only to CP value 0x0000000D.

cp[3]: 0x0000000E specifies that the last CP value to which pcd[2] applies is 0x0000000D.

pcd[0]: Specifies the location of text for CP values zero through 5, inclusive. This structure is expanded in the following table.

pcd[1]: Specifies the location of text for CP values 0x00000006 through 0x0000000C, inclusive. This structure is expanded following.

pcd[2]: Specifies the location of text for CP value 0x0000000D. This structure is expanded following.

The following table shows the expansion of pcd[0]. This structure specifies the location of the text at CP zero through 5, inclusive.

Figure 6: The expansion of pcd[0]

fNoParaLast: 0x1 specifies that the text that is referenced by this Pcd structure does not contain any paragraph marks.

fc.fc: 0x00000C22 specifies the offset, in bytes, in the WordDocument Stream where the text at CP zero begins. Because cp[1] is 0x00000006, there are 6 characters of text at this offset.

fc.fCompressed: 0x0 specifies that the text at offset fc.fc in the WordDocument Stream consists of 16-bit Unicode characters.

prm0.fComplex: 0x0 specifies that this is a Prm0 structure, as opposed to a Prm1 structure.

prm0.isprm: 0x00 specifies that sprmCLbcCRJ is applied to the range of CPs that are referenced by this Pcd structure. However, an isprm of 0x0000, combined with a val of 0x0000, is a special case that specifies that the CPs that are referenced by this Pcd have no additional formatting from their Pcd structure

prm0.val: 0x00, combined with isprm 0x0000, specifies that the CPs that are referenced by this Pcd have no additional formatting from their Pcd.

The following shows the expansion of pcd[1]. This structure specifies the location of the text at CP 0x0000006 through 0x0000000C, inclusive.

Figure 22: Expansion of pcd[1]

fNoParaLast: 0x0 specifies that the text that is referenced by this Pcd might contain a paragraph mark. A value of 0x0001 specifies that there is no paragraph mark. A value of 0x0000 specifies that the referenced text might or might not contain a paragraph mark.

fc.fc: 0x00000800 specifies the offset, in bytes, in the WordDocument Stream where the text at CP 0x00000006 begins. Because fCompressed is 1, the actual offset is fc/2, or 0x00000400. Because cp[2] is 0x0000000D, there are 7 characters at this offset.

fc.fCompressed: 0x1 specifies that the text at offset fc/2 consists of 8-bit ANSI characters, except for the values that are listed in the table in the specification of FcCompressed (section 2.9.73).

prm0.fComplex: 0x0 specifies that this is a Prm0 structure, as opposed to a Prm1 structure.

prm0.isprm: 0x00 specifies that sprmCLbcCRJ is applied to the range of CPs that are referenced by this Pcd. However, an isprm of 0x0000, combined with a val of 0x0000, is a special case that specifies that the CPs referenced by this Pcd have no additional formatting from their Pcd.

prm0.val: 0x00, combined with isprm 0x0000, specifies that the CPs that are referenced by this Pcd structure have no additional formatting from their Pcd.

The following shows the expansion of pcd[2]. This structure specifies the location of the text at CP 0x0000000D.

Figure 23: Expansion of pcd[2]

fNoParaLast: 0x0 specifies that the text that is referenced by this Pcd might contain a paragraph mark. A value of 0x0001 specifies that there is no paragraph mark. A value of 0x0000 indicates that a paragraph mark might, or might not, be contained in the referenced text.

fc.fc: 0x0000080E specifies the offset, in bytes, in the WordDocument Stream where the text at CP 0x0000000D begins. Because fCompressed is 1, the actual offset is fc/2, or 0x00000407. Because cp[3] is 0x0000000E, there is 1 character at this offset.

fc.fCompressed: 0x1 specifies that the text at offset fc/2 consists of 8-bit ANSI characters, except for the values that are listed in the table in the specification of FcCompressed (section 2.9.73).

prm0.fComplex: 0x0 specifies that this is a Prm0 structure, as opposed to a Prm1 structure.

prm0.isprm: 0x00 specifies that sprmCLbcCRJ is applied to the range of CPs that are referenced by this Pcd. However, an isprm of 0x0000, combined with a val of 0x0000, is a special case that specifies that the CPs that are referenced by this Pcd have no additional formatting from their Pcd.

prm0.val: 0x00, combined with isprm 0x0000, specifies that the CPs that are referenced by this Pcd have no additional formatting from their Pcd.

The following shows the Unicode text at offset 0x00000C22 in the WordDocument Stream. This is an array of two-byte characters. This array is not null-terminated.

Figure 9: The text at offset 0x00000C22 in the Table Stream

text[0]: 0x0048 Unicode 'H'.

text[1]: 0x0065 Unicode 'e'.

text[2]: 0x006C Unicode 'l'.

text[3]: 0x006C Unicode 'l'.

text[4]: 0x006F Unicode 'o'.

text[5]: 0x0020 Unicode space.

The following shows the ANSI text at offset 0x00000400 in the WordDocument Stream. This is an array of single byte characters. This array is not null-terminated.

Figure 10: The text at offset 0x00000400 in the WordDocument Stream

text[0]: 0x57 ANSI 'W'.

text[1]: 0x6F ANSI 'o'.

text[2]: 0x72 ANSI 'r'.

text[3]: 0x6C ANSI 'l'.

text[4]: 0x64 ANSI 'd'.

text[5]: 0x2E ANSI period ('.').

text[6]: 0x0D ANSI paragraph mark.

The following structure shows the ANSI text at offset 0x00000407 in the WordDocument Stream. This is an array of single byte characters. This array is not null-terminated.

Figure 11: The text at offset 0x00000407 in the WordDocument Stream

text[0]: 0x0D ANSI paragraph mark.

The complete text of this document is therefore, "Hello World", followed by a period and two paragraph marks.