You are here: C++ API > Classes > dtsDataSource Structure > dtsDataSource::getNextDocInfo Data Member
Close
dtSearch Text Retrieval Engine Programmer's Reference
Contents|Index|Home
Previous|Up|Next
dtsDataSource::getNextDocInfo Data Member
dtsDataSource Structure
Syntax
C++
int (* getNextDocInfo)(void *pData, dtsDataSourceFileInfo& fileInfo);

dtsDataSource Structure

Parameters
Description
pData
The value of dtsDataSource.pData
fileInfo
Structure to receive the properties of the document

0 on success, or -1 if there are no more documents to return

Pointer to a function that will return information about a the next document in the data source.

The data source implementation should ensure that string pointers in the dtsDataSourceFileInfo remain valid until the next getNextDocInfo call. Following a getNextDocInfo call, the dtSearch Engine may either call getCurrentDoc to get the document contents, or it may call getNextDocInfo again to get the next document.