BFSecureRequest Class Reference

---

Description

An object that represents a reusable request to preform analysis and/or scrubbing. A single instance of this object should be created and reused to process many documents.

#include <secureapi.h>

List of all members.

Public Member Functions
	BFSecureRequest ()
	~BFSecureRequest ()
void	Execute ()
BFSecureResponse *	GetSecureResponse ()
Static Public Member Functions
static void	Startup (int features)
static void	Shutdown ()
static void	AttachThread ()
static void	DetachThread ()
static void	GetOptionId (int option, std::wstring &name)
static void	GetOptionName (int option, std::wstring &name)
static void	GetOptionShortDescription (int option, std::wstring &description)
static void	GetOptionLongDescription (int option, std::wstring &description)
static void	GetFileFormatName (const FileFormats format, std::wstring &name)
static void	GetFileFormatDescription (const FileFormats format, std::wstring &description)
static void	GetFileFormatExtension (const FileFormats format, std::wstring &extension)

---

Constructor & Destructor Documentation

BFSecureRequest::BFSecureRequest

(

)

[inline]

Constructs a BFSecureRequest object

BFSecureRequest::~BFSecureRequest

(

)

[inline]

Destroys a BFSecureRequest object

---

Member Function Documentation

void BFSecureRequest::Execute

(

)

[inline]

Execute the secure request. Executes a request to analyze or scrub a document. Use the SetOption methods to setup the request before calling this function.

BFSecureResponse * BFSecureRequest::GetSecureResponse

(

)

[inline]

Gets a BGSecureResponse object that contains the response to the most recent call to BFSecureRequest::Execute.

Returns:

Pointer to a BFSecureResponse object. This objects lifetime is under developer control and is not bound to BFSecureRequest object from which it is retrieved. The developer must delete the object when finished using it.

void BFSecureRequest::Startup

(

int

features

)

[inline, static]

Initialize the API. Must be called before calling any other static methods or creating any Clean Content objects. Must only be called once per process.

Parameters:

features

Reserved for future use. Must be 0

void BFSecureRequest::Shutdown

(

)

[inline, static]

Clean up the API. Must be called after all use of this API is complete. Must be called from the same thread that called BFSecureRequest::Startup().

void BFSecureRequest::AttachThread

(

)

[inline, static]

Start using this API in a new thread. Must be called for each new thread that will use this API, not including the thread in which BFSecureRequest::Startup() is called. Threads that call this method must call BFSecureRequest::DetachThread() before BFSecureRequest::Shutdown() is called.

void BFSecureRequest::DetachThread

(

)

[inline, static]

Finish using this API in a thread. Must be called for each thread that called BFSecureRequest::AttachThread() after the thread has finished using this API.

void BFSecureRequest::GetOptionId	(	int	option,
		std::wstring &	name
	)			[inline, static]

Gets the id for an option.

Parameters:

	option	One of the values in ScrubOptions, AnalyzeOptions, BooleanOptions, FileFormatOptions or FileOptions
	name	String that will receive the id

void BFSecureRequest::GetOptionName	(	int	option,
		std::wstring &	name
	)			[inline, static]

Gets the name for an option.

Parameters:

	option	One of the values in ScrubOptions, AnalyzeOptions, BooleanOptions, FileFormatOptions or FileOptions
	name	String that will receive the name

void BFSecureRequest::GetOptionShortDescription	(	int	option,
		std::wstring &	description
	)			[inline, static]

Gets the short description for an option.

Parameters:

	option	One of the values in ScrubOptions, AnalyzeOptions, BooleanOptions, FileFormatOptions or FileOptions
	description	String that will receive the description

void BFSecureRequest::GetOptionLongDescription	(	int	option,
		std::wstring &	description
	)			[inline, static]

Gets the long description for an option.

Parameters:

	option	One of the values in ScrubOptions, AnalyzeOptions, BooleanOptions, FileFormatOptions or FileOptions
	description	String that will receive the description

void BFSecureRequest::GetFileFormatName	(	const FileFormats	format,
		std::wstring &	name
	)			[inline, static]

Gets the name for a file format

Parameters:

	format	One of the values in FileFormats
	name	String that will receive the name

void BFSecureRequest::GetFileFormatDescription	(	const FileFormats	format,
		std::wstring &	description
	)			[inline, static]

Gets the description for a file format

Parameters:

	format	One of the values in FileFormats
	description	String that will receive the description

void BFSecureRequest::GetFileFormatExtension	(	const FileFormats	format,
		std::wstring &	extension
	)			[inline, static]

Gets the extension associated with a file format

Parameters:

	format	One of the values in FileFormats
	extension	String that will receive the extension

Inheritance diagram for BFSecureRequest:

---

The documentation for this class was generated from the following file:

• secureapi.h