FLAIM: FlmBlob Class Reference

- Main Page
- Modules
- Classes
- Files

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# FlmBlob Class Reference

This class provides an interface for handling binary large objects. More...

`#include <flaim.h>`

List of all members.

## Public Member Functions
virtual RCODE | referenceFile (HFDB hDb, const char *pszFilePath, FLMBOOL bOwned=FALSE)=0
| Setup the blob object to reference an external file.
virtual FLMINT | compareFileName (const char *pszFileName)=0
| Compare the file name refered to by the BLOB object with the passed in file name.
virtual RCODE | buildFileName (char *pszFileName)=0
| Return the file name referred to by the BLOB object.

## Detailed Description

This class provides an interface for handling binary large objects.

Currently, FLAIM only supports referencing of external files. BLOB data is not actually stored "in" the database.

## Member Function Documentation

virtual RCODE FlmBlob::buildFileName | ( | char * | pszFileName | ) | `[pure virtual]`

  | Return the file name referred to by the BLOB object. Parameters:
  pszFileName | File name is returned here.

virtual FLMINT FlmBlob::compareFileName | ( | const char * | pszFileName | ) | `[pure virtual]`

  | Compare the file name refered to by the BLOB object with the passed in file name. Will return zero if the file names are equal, non-zero otherwise. Parameters:
  pszFileName | File name to compare to.

virtual RCODE FlmBlob::referenceFile | ( | HFDB | hDb,
|  | const char * | pszFilePath,
|  | FLMBOOL | bOwned = `FALSE`
| ) | `[pure virtual]`

  | Setup the blob object to reference an external file. Parameters:
  hDb | Database handle.
  pszFilePath | Name of file the blob is to reference.
  bOwned | Is the external file "owned" by the database? If TRUE, when the record referencing the BLOB is deleted, FLAIM will automatically delete the file.