dtsViewerInfo Structure

struct dtsViewerInfo {
  char name[maxTypeNameLen];
  unsigned short typeId;
  char version[maxTypeNameLen];
  dtsRecognitionSignature signature;
  const char * filenamePattern;
  long filenameConfidence;
  unsigned long blockSize;
  int (* recognize)(dtsInputStream& aStream);
  dtsViewerHandle (* makeViewer)(dtsInputStream& aStream);
  void (* destroyViewer)(dtsViewerHandle handle);
  void (* readTextBlock)(dtsViewerHandle handle, dtsTextBlock& block);
  void (* gotoBookMark)(dtsViewerHandle handle, dtsBookMark& bookMark);
  void (* getFileInfo)(dtsViewerHandle handle, dtsFileInfo& info);
  long flags;
  long (* getCount)(dtsViewerHandle handle);
  int (* getFirst)(dtsViewerHandle handle, dtsContainerItemInfo& info);
  int (* getNext)(dtsViewerHandle handle, dtsContainerItemInfo& info);
  int (* getInfoByName)(dtsViewerHandle handle, const char *name, dtsContainerItemInfo& info);
  int (* getInfoByIndex)(dtsViewerHandle handle, long index, dtsContainerItemInfo& info);
  int (* extractToMem)(dtsViewerHandle handle, dtsContainerItemInfo& info, void *dest, long bufLen);
  int (* extractToFile)(dtsViewerHandle handle, dtsContainerItemInfo& info, const char *fileToCreate);
  char canExtractToMem;
  dtsViewerHandle (* makeViewer2)(dtsMakeViewerParams& params);
};

File

dtsviewr.h

Data Members

Data Member	Description
blockSize	Size of the text blocks to pass to the readTextBlock function.
canExtractToMem	True if this file parser implements extractToMem
destroyViewer	Delete the object represented by a handle previously returned by makeViewer.
extractToFile	Pointer to function that will extract an item from the container to a temporary file.
extractToMem	Pointer to function that will extract an item from the container to a memory buffer.
filenameConfidence	If the filename matches filenamePattern, identifies how confident the parser is that the file belongs to the parser.
filenamePattern	Used to determine whether a file belongs to this file parser.
flags	ViewerInfoFlags describing this file parser
getCount	Pointer to function that will return the number of files in the container.
getFileInfo	Get basic information about the document associated with handle.
getFirst	Pointer to function that will get information about the first item in the container.
getInfoByIndex	Pointer to function that will get information about an item in the container, identified by its numerical index.
getInfoByName	Pointer to function that will get information about a named item in the container.
getNext	Pointer to function that will get information about the next item in the container.
gotoBookMark	Reposition the parser's input pointer to the start of the text block identified by the dtsBookMark, or any earlier position in the file.
makeViewer	Create a file parser for a dtsInputStream.
makeViewer2	Pointer to a function that will create a file parser for a dtsInputStream, using information provided in a dtsMakeViewerParams struct.
name	Name of the file format
readTextBlock	read a block of text from the input and store it in a dtsTextBlock.
recognize	If not NULL, will be called to determine whether the a file has the format recognized by the parser.
signature	A dtsRecognitionSignature that is used to determine whether a file belongs to this file parser.
typeId	Numeric identifier for the viewer.
version	For diagnostic purposes only, a string identifying the version of the parser.

Group

Classes

Methods

Method	Description
clear	Clear all data from a dtsViewerInfo
copy	Copy a dtsViewerInfo

Legend

	Data Member
	Method

Links

Data Members, Classes, Legend, Members, Methods