DMemoryInputStream Class

Input stream representing a document stored in memory.

File

File: DInputStream.h

Namespace: dtSearch

DMemoryInputStream Constructor

Syntax

C++

class DMemoryInputStream : public DInputStreamBase;

Constructors

Show:Inherited

No members matching the current filter

	Name	Description
	DInputStreamBase()	Default constructor (Inherited from DInputStreamBase)
	DInputStreamBase(dtsFileInfo&)	Construct a DInputStreamBase, initializing it with the file properties in info (Inherited from DInputStreamBase)
	DMemoryInputStream()	Constructor for an empty input stream. Use setTextData or setBinaryData to store document contents for the input stream.
	DMemoryInputStream(dtsFileInfo&, const char *)	Create an input stream in memory from file properties and plain text

Data Members

Show:InheritedProtected

No members matching the current filter

	Name	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)
	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)

Group

Classes

Members

Data Members

Show:InheritedProtected

No members matching the current filter

	Name	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)
	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)

Constructors

Show:Inherited

No members matching the current filter

	Name	Description
	DInputStreamBase()	Default constructor (Inherited from DInputStreamBase)
	DInputStreamBase(dtsFileInfo&)	Construct a DInputStreamBase, initializing it with the file properties in info (Inherited from DInputStreamBase)
	DMemoryInputStream()	Constructor for an empty input stream. Use setTextData or setBinaryData to store document contents for the input stream.
	DMemoryInputStream(dtsFileInfo&, const char *)	Create an input stream in memory from file properties and plain text

Methods

Show:Inherited

No members matching the current filter

	Name	Description
	clone	Allocate a new DMemoryInputStream with its own copy of the data in this one.
	getBuffer	Returns a pointer to the start of the buffer DMemoryInputStream uses to store data
	getBufferSize	Returns the size of the buffer DMemoryInputStream uses to store data
	getDataSize	Returns the size of the data stored in this 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)
	read	Reads data from the input stream (Inherited from DInputStreamBase)
	read	Reads data from the input stream
	seek	Change the seek pointer for the input (Inherited from DInputStreamBase)
	seek	Change the seek pointer for the input
	setBinaryData	Set binary data, such as the contents of a Microsoft Word document or a PDF file, as the contents of this document.
	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)
	setTextData	Store plain text as the contents of this document
	tell	Returns the current position of the seek pointer for the input (Inherited from DInputStreamBase)
	tell	Returns the current position of the seek pointer for the input

Methods

Show:Inherited

No members matching the current filter

	Name	Description
	clone	Allocate a new DMemoryInputStream with its own copy of the data in this one.
	getBuffer	Returns a pointer to the start of the buffer DMemoryInputStream uses to store data
	getBufferSize	Returns the size of the buffer DMemoryInputStream uses to store data
	getDataSize	Returns the size of the data stored in this 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)
	read	Reads data from the input stream (Inherited from DInputStreamBase)
	read	Reads data from the input stream
	seek	Change the seek pointer for the input (Inherited from DInputStreamBase)
	seek	Change the seek pointer for the input
	setBinaryData	Set binary data, such as the contents of a Microsoft Word document or a PDF file, as the contents of this document.
	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)
	setTextData	Store plain text as the contents of this document
	tell	Returns the current position of the seek pointer for the input (Inherited from DInputStreamBase)
	tell	Returns the current position of the seek pointer for the input

Legend

	Data Member
	protected
	Constructor
	abstract

Remarks

Input streams are used in the dtsDataSource API.

The contents of the input stream can be plain text or binary data. Binary data is parsed in the dtSearch Engine exactly as if it were a disk file, so a memory input stream can be used with binary file formats such as Microsoft Word documents, PDF files, etc.