OdDbHostAppServices::findFile Method

Syntax

C++

virtual OdString findFile(const OdString& filename, OdDbBaseDatabase* pDb = 0, FindFileHint hint = kDefault);

Parameters	Description
const OdString& filename	[in] Name of the file to find.
OdDbBaseDatabase* pDb = 0	[in] Pointer to the database context.
FindFileHint hint = kDefault	[in] Hint that indicates the type of file that is required.

Returns the fully qualified path to the specified file.

Returns an empty string if the file is not found.

This function is called when the database needs access to a file, such as a font file, a template file, etc.

pDb == 0 specifies that this file search is not related to a database.

If pDb != 0, call pDb->getFilename() to determine the path to the DWG file associated with the database.

The typical search order is as follows:

hint must be one of the following:

Name	Value	Description Extension
kDefault	0	Any file. any
kFontFile	1	Can be either SHX or TTF file. SHX or TTF
kCompiledShapeFile	2	SHX file. SHX
kTrueTypeFontFile	3	TTF file. TTF
kEmbeddedImageFile	4	Image file. ISM
kXRefDrawing	5	Drawing template file. DWT
kPatternFile	6	Pattern file (PAT) PAT
kTXApplication	7	ODA Xtension file. TX
kFontMapFile	8	FontMap file FMP
kUnderlayFile	9	Underlay file
kTextureMapFile	10

The client application can, in fact return any non-null string, so long as the application can handle that string in OdDbSystemServices::createFile.