 dtSearch Text Retrieval Engine Programmer's Reference 7.70 |
dtsDataSource::getDocInfoByName Data Member
|
dtSearch Text Retrieval Engine Programmer's Reference 7.70 |
Pointer to a function that will return information about a named document in the data source.
int (* getDocInfoByName)(void *pData, const char *docName, const char *userFields, dtsDataSourceFileInfo& fi);
|
Parameters |
Description |
|
pData |
The value of dtsDataSource.pData |
|
docName |
The name of the document in the data source |
|
userFields |
Null-delimited string set containing any stored fields associated with this document. |
0 on success, or -1 if the document could not be accessed.
If the document could not be returned, the specific error should be provided in dtsDataSourceFileInfo.accessResult.
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.
|
Copyright (c) 1995-2012 dtSearch Corp. All rights reserved.
|
Parameters