You are here: C++ API > Classes > dtsSearchResults Class > dtsSearchResults::getDocInfoStrings Method
Close
dtSearch Text Retrieval Engine Programmer's Reference
dtsSearchResults::getDocInfoStrings Method

Generates a null-delimited string set containing field information associated with a document.

Syntax
C++
int getDocInfoStrings(int iItem, char * buf, ptrdiff_t bufSize);
Parameters
Description
int iItem
The item to generate the string from (a zero-based index into the search results list).
char * buf
Buffer to receive the generated string.
ptrdiff_t bufSize
Size of the buffer.

Size of the string set generated. If the data is larger than bufSize, the size of the buffer needed is returned, and partial data is copied to buf

The fields are generated from data in dtsSearchResultsItem. In C++ applications, it is more efficient to access the data directly using dtsSearchResultsItem

All built-in fields are prefixed with an underscore. Additionally, any fields in the userFields set will also be included. 

 

Field
Description
_filename
Path and filename of the document.
_shortName
Name of the document, without the path.
_location
Folder where the document is located.
_displayName
If non-blank, an alternative name to display for the document (for example, the title of an HTML document).
_title
The first 80 characters of the document.
_score
In a natural language search, the weighted score for the document.
_hitcount
Number of hits found for this document.
_size
Size of the document when indexed, in bytes.
_wordcount
Number of words in the document when indexed.
_date
Modification date of the document when indexed, in local date format.
_genericDate
Modification date of the document when indexed, in generic date format (M03/D25/Y1997).
_createdDate
Created date of the document when indexed, in local date format.
_genericCreatedDate
Created date of the document when indexed, in generic date format (M03/D25/Y1997).
_time
Modification time of the document in HH:MM:SS format.
_iindex
The index that the document was retrieved from (an index into the list in the IndexesToSearch list in the DSearchJob).
_docid
Document id of this document in the index.
_typeId
TypeId specifying the file format of the document.
_typeName
File format of the document, as a string.
_indexPath
Path of the index that the document was retrieved from
_hitDetails
_hitsByWord
_synopsis
Snippet of text showing hits in context (see ReportFlags flag dtsReportStoreInResults).
Copyright (c) 1995-2020 dtSearch Corp. All rights reserved.