Content Description

This chapter discusses tagged content and other content topics.

This chapter includes the following sections:

SCCCA_BEGINTAG/SCCCA_ENDTAG: Tagged Content

The SCCCA_BEGINTAG and SCCCA_ENDTAG content types are used to tag or delimit other content for a particular purpose. This can be especially useful when searching for specific document property values like the author or title of a document. It can also be used to separate subdocument text like headers, footers, and footnotes from the main document text. Tagged text may be nested inside other tagged text, and tags may overlap each other.

Though most tag types are not particularly useful to developers, the Data Access technology provides all of the tag types rather than make a judgment as to usability. Each is briefly described below.

SCCCA_BEGINTAG Content Description

This section lists the applicable parameters and corresponding values.

Tag Types

This section lists the applicable values and corresponding descriptions.

When dwSubType is SCCCA_DOCUMENTPROPERTY, dwData1 will be one of the values listed in the header file sccca.h. The following section, Document Property IDs, lists many of the common document property types. Any content generated between the begin and end tag defines the value of the document property.

When dwSubType is SCCCA_EMAILFIELD, dwData1 will be one of the values in Mail Field IDs, and any content generated between the begin and end tag defines the value of the email field.

Document Property IDs

The following is a partial list of document property IDs.

SCCCA_SUBDOCPROPERTY Document Properties

The following values are properties of SCCCA_SUBDOCPROPERTY:

Mail Field IDs

This is a partial list of fields found in mail documents and archives.

SCCCA_BREAK: Content Breaks

This content type is used internally, and may be ignored.

SCCCA_CELL: Cell Boundary

SCCCA_CELL will appear before the contents of a cell in a spreadsheet or database and will contain coordinates that indicate the starting and ending position of the cell. If the cell isn’t merged, then the starting and ending positions will be the same. The content contained by the cell is assumed to end when the next SCCCA_CELL or SCCCA_SHEET is output.

SCCCA_CELL Content Description

SCCCA_COMMENTREFERENCE

A SCCCA_COMMENTREFERENCE is placed in the actual location of the comment. The body of the comment may appear elsewhere and will be tagged with a SCCCA_BEGINTAG of type SCCCA_SUBDOCTEXT and will have the same Id as the SCCCA_COMMENTREFERENCE.

SCCCA_FILEPROPERTY: File Property Content

Returns the file identification information for a document. This property is generated by the CAReadFirst function.

SCCCA_FILEPROPERTY Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_GENERATED: Generated Information

Identical to SCCCA_TEXT, except that the characters come not from the original document, but from some other non-character data (numbers in spreadsheets, dates, and so forth). Because the text is not from the original document, the characters do not contribute toward character counts.

SCCCA_GENERATED Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_OBJECT: SubObjects

This content type is provided to allow the developer to access the content of SubObjects, like embedded graphics or objects in an archive. The SubObject can then be opened by DAOpenDocument, filling the IOSPECSUBOBJECT or the IOSPECARCHIVEOBJECT parameter with one of the following values:

SCCCA_OBJECT Content Description

These values may change if different options are applied, with different versions of the technology, or after patches are applied.

SCCCA_OBJECTALTSTRING: Alternate String

This content type provides an alternate string to identify an embedded object.

SCCCA_OBJECTALTSTRING Content Description

SCCCA_OBJECTNAME: Object Name

This content type is provided to identify the name of an embedded object.

SCCCA_OBJECTNAME Content Description

SCCCA_RECORD: Archive Record

This content is output to allow the customer to easily group fields that appear in an archive or in an email archive. The record is considered to be open until a SCCCA_OBJECT is encountered with the flag SCCCA_ENDRECORD set.

SCCCA_RECORD Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_REVISION_CELL: Revision Cell

The location of a cell within a track changes block.

SCCCA_REVISION_CELL Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_REVISION_ROW: Revision Row

This describes a series of rows within a track changes block.

SCCCA_REVISION_ROW Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_REVISION_COLUMN: Revision Column

This describes a series of columns within a track changes block.

SCCCA_REVISION_COLUMN Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_REVISION_SHEET: Revision Sheet

This describes the new and old sheet names within a track changes block. The numbers will relate to names output with SCCCA_REVISION_SHEETNAME tags.

SCCCA_REVISION_SHEET Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_REVISION_SHEETNAME: Revision Sheet Name

Provides the name and number of a sheet within a track changes block.

SCCCA_REVISION_SHEETNAME Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_REVISION_USER: Revision User

This describes the name associated with a user ID.

SCCCA_REVISION_USER Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_SHEET: Sheet Names

This content type contains only the sheet name (worksheet in a spreadsheet, slide in presentation, and so forth). This content is not optional. It is always created if the information is present. Of course, the client can ignore this text when it is returned.

SCCCA_SHEET Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_SLIDE: Presentation Slide

SCCCA_SLIDE appears before the contents of a slide in a presentation document. The content contained by the slide is assumed to end when the next SCCCA_SLIDE is output, or the end of the document is reached.

SCCCA_STYLECHANGE: Style Information

The SCCCA_STYLECHANGE content type is used to indicate changes in style information. This style information can be used to delimit particularly interesting content.

SCCCA_STYLECHANGE Content Description

This section lists the applicable parameters and corresponding values.

SCCCA_TEXT: Text Content

This content type denotes document text, including special characters such as page breaks and tabs.

The technology guarantees that the text generated by the Content Access technology is identical to the text generated by the Outside In Viewer technology raw-text feature. This allows character counts generated at indexing time using Content Access to be directly mapped to viewer positions at viewing time for search-hit highlighting. However, Content Access has abilities beyond the raw-text feature of the Viewer, such as the ability to retrieve non-visible text such as document properties and hidden text, and the ability to retrieve text from embedded documents.

When the output character is DBCS or Unicode, the character count will not be the same as the buffer byte count because these character sets may generate more than one byte per character. The byte ordering used for multi-byte character sets such as these will be system-dependent; on a computer using an Intel processor, the low byte will be first.

It is important to note that generated numeric data fields, such as date, time, and spreadsheet numbers, are not included in the content returned by SCCCA_TEXT. For information on how such text can be returned by Content Access, see SCCCA_GENERATED: Generated Information.

SCCCA_TEXT Content Description

This section lists the applicable parameters and corresponding values.

Special Text Character Substitutions

SCCCA_TREENODELOCATOR: Tree Node Locator

This content type contains information to be used in the SOTREENODELOCATOR structure, which is used by DAOpenRandomTreeRecord and DASaveRandomTreeRecord. These values may change if different options are applied, with different versions of the technology, or after patches are applied.

SCCCA_TREENODELOCATOR Content Description