DFileInputStream Class

Implements an input stream representing a document stored in a disk file.

File

File: DInputStream.h

Namespace: dtSearch

open Method

Syntax

C++

class DFileInputStream : public DInputStreamBase;

Data Members

Show:InheritedProtected

No members matching the current filter

Data Member	Description
Fields	String set containing pairs of field names and values to be associated with a document. These field-value pairs are passed to the indexer as dtsInputStream.fields. (Inherited from DInputStreamBase)
file	The file
length	Length of the file
m_bSuppressDeleteOnReleaseCB	Normally when releaseCB is called, the object is deleted. Set this flag to suppress if the caller will manage the object lifetime. (Inherited from DInputStreamBase)
pos	Current read position

Group

Classes

Members

Data Members

Show:InheritedProtected

No members matching the current filter

Data Member	Description
Fields	String set containing pairs of field names and values to be associated with a document. These field-value pairs are passed to the indexer as dtsInputStream.fields. (Inherited from DInputStreamBase)
file	The file
length	Length of the file
m_bSuppressDeleteOnReleaseCB	Normally when releaseCB is called, the object is deleted. Set this flag to suppress if the caller will manage the object lifetime. (Inherited from DInputStreamBase)
pos	Current read position

Methods

Show:Inherited

No members matching the current filter

Method	Description
DFileInputStream	Constructor
DInputStreamBase()	Default constructor (Inherited from DInputStreamBase)
DInputStreamBase(dtsFileInfo&)	Construct a DInputStreamBase, initializing it with the file properties in info (Inherited from DInputStreamBase)
close	Close the file associated with the input stream
getFileInfo	Get file properties (filename, modification date, etc.) for an input stream (Inherited from DInputStreamBase)
getName	Returns the filename associated with the input stream (Inherited from DInputStreamBase)
open(const char *)	Open a disk file to provide input for the input stream using a UTF-8 filename
open(const wchar_t *)	Open a disk file to provide input for the input stream using a Unicode
openUi	Open a disk file to provide input for the input stream using a const TCHAR * filename
read	Reads data from the input stream
read	Reads data from the input stream (Inherited from DInputStreamBase)
seek	Change the seek pointer for the input
seek	Change the seek pointer for the input (Inherited from DInputStreamBase)
setFileInfo	Assign file properties (filename, modification date, etc.) to an input stream (Inherited from DInputStreamBase)
setName	Assigns a filename to the input stream (Inherited from DInputStreamBase)
setOpenFailInfo	If a document could not be opened, use setOpenFailInfo to report the error code and message. (Inherited from DInputStreamBase)
tell	Returns the current position of the seek pointer for the input
tell	Returns the current position of the seek pointer for the input (Inherited from DInputStreamBase)

Methods

Show:Inherited

No members matching the current filter

Method	Description
DFileInputStream	Constructor
DInputStreamBase()	Default constructor (Inherited from DInputStreamBase)
DInputStreamBase(dtsFileInfo&)	Construct a DInputStreamBase, initializing it with the file properties in info (Inherited from DInputStreamBase)
close	Close the file associated with the input stream
getFileInfo	Get file properties (filename, modification date, etc.) for an input stream (Inherited from DInputStreamBase)
getName	Returns the filename associated with the input stream (Inherited from DInputStreamBase)
open(const char *)	Open a disk file to provide input for the input stream using a UTF-8 filename
open(const wchar_t *)	Open a disk file to provide input for the input stream using a Unicode
openUi	Open a disk file to provide input for the input stream using a const TCHAR * filename
read	Reads data from the input stream
read	Reads data from the input stream (Inherited from DInputStreamBase)
seek	Change the seek pointer for the input
seek	Change the seek pointer for the input (Inherited from DInputStreamBase)
setFileInfo	Assign file properties (filename, modification date, etc.) to an input stream (Inherited from DInputStreamBase)
setName	Assigns a filename to the input stream (Inherited from DInputStreamBase)
setOpenFailInfo	If a document could not be opened, use setOpenFailInfo to report the error code and message. (Inherited from DInputStreamBase)
tell	Returns the current position of the seek pointer for the input
tell	Returns the current position of the seek pointer for the input (Inherited from DInputStreamBase)

Description

Input streams are used in the dtsDataSource API.