BFOptionSet Class Reference

#include <secureapi.h>

Public Member Functions
	BFOptionSet (const BFHANDLE optionset)
virtual	~BFOptionSet ()
bool	IsValid ()
void	SetOption (BooleanOptions option, const bool value)
void	SetOption (IntegerOptions option, const int value)
void	SetOption (DateOptions option, const int year, const int month, const int day, const int hour, const int minute, const int second)
void	SetOption (DurationOptions option, const int value)
void	SetOption (EnumOptions option, const int value)
void	SetOption (EnumListOptions option, const int values[], const int count)
void	SetOption (StringOptions option, const std::wstring &str)
void	SetOption (StringListOptions option, const std::wstring strs[], const int count)
void	SetOption (FileOptions option, const std::wstring &path)
void	SetOption (FileOptions option, void *memory, const long length)
void	SetOption (FileOptions option, BFChannel *channel)
void	SetOption (HandlerOptions option, BFElementHandler *eh)
void	SetOption (DirectoryOptions option, const std::wstring &path)
void	SetOption (ScrubOptions option, ScrubOptionActions action)
void	SetOption (AnalyzeOptions option, ScrubOptionActions action)
void	SetOption (FileFormatOptions option, FileFormats format)
void	SetOption (FileFormatListOptions option, FileFormats formats[], int count)
bool	GetOption (BooleanOptions option)
BFINT64	GetOption (IntegerOptions option)
void	GetOption (StringOptions option, std::wstring &str)
void	GetOption (FileOptions option, std::wstring &path)
ScrubOptionActions	GetOption (ScrubOptions option)
ScrubOptionActions	GetOption (AnalyzeOptions option)
FileFormats	GetOption (FileFormatOptions option)
void	GetOption (FileFormatListOptions option, FileFormats formats[], int *count)
void	ReadOptionsFromXML (std::wstring &path)
void	WriteOptionsToXML (std::wstring &path)
Protected Member Functions
	BFOptionSet ()
Static Protected Member Functions
static void	HandleError (int error, BFHANDLE errorinfo)
Protected Attributes
BFHANDLE	request

Constructor & Destructor Documentation

BFOptionSet::BFOptionSet ( ) [inline, protected]

BFOptionSet::BFOptionSet ( const BFHANDLE optionset ) [inline]

Constructs a BFOptionSet object based on a C handle to an option set

BFOptionSet::~BFOptionSet ( ) [inline, virtual]

Destroys a BFOptionSet object

Member Function Documentation

void BFOptionSet::HandleError	(	int	error,
		BFHANDLE	errorinfo
	)			`[inline, static, protected]`

bool BFOptionSet::IsValid ( ) [inline]

Tests if an option set is valid

Returns:: TRUE if the option set is valid

void BFOptionSet::SetOption	(	BooleanOptions	option,
		const bool	value
	)			`[inline]`

Sets a boolean option

Parameters:

	option	One of the values in BooleanOptions
	value	The option's new value

void BFOptionSet::SetOption	(	IntegerOptions	option,
		const int	value
	)			`[inline]`

Sets an integer option

Parameters:

	option	One of the values in IntegerOptions
	value	The option's new value

void BFOptionSet::SetOption	(	DateOptions	option,
		const int	year,
		const int	month,
		const int	day,
		const int	hour,
		const int	minute,
		const int	second
	)			`[inline]`

Sets a date option

Parameters:

	option	One of the values in DateOptions
	year	The year, value is AD
	month	The month, value is 0-based where 0 is January
	day	Day of the month
	hour	Hour
	minute	Minute
	second	Second

void BFOptionSet::SetOption	(	DurationOptions	option,
		const int	value
	)			`[inline]`

Sets a duration option

Parameters:

	option	One of the values in DurationOptions
	value	The duration in milliseconds

void BFOptionSet::SetOption	(	EnumOptions	option,
		const int	value
	)			`[inline]`

Sets an enum option

Parameters:

	option	One of the values in EnumOptions
	value	The option's new value

void BFOptionSet::SetOption	(	EnumListOptions	option,
		const int	values[],
		const int	count
	)			`[inline]`

Sets an enum list option

Parameters:

	option	One of the values in EnumListOptions
	values	The option's new values
	count	The number of items in the values array

void BFOptionSet::SetOption	(	StringOptions	option,
		const std::wstring &	str
	)			`[inline]`

Sets a string option

Parameters:

	option	One of the values in StringOptions
	str	The option's new value

void BFOptionSet::SetOption	(	StringListOptions	option,
		const std::wstring	strs[],
		const int	count
	)			`[inline]`

Sets a string list option

Parameters:

	option	One of the values in StringListOptions
	strs	An array of strings that will be the options new value
	count	Number of stings in the array

void BFOptionSet::SetOption	(	FileOptions	option,
		const std::wstring &	path
	)			`[inline]`

Sets a file option using a full path to a file

Parameters:

	option	One of the values in FileOptions
	path	A full path to the file

void BFOptionSet::SetOption	(	FileOptions	option,
		void *	memory,
		const long	length
	)			`[inline]`

Sets a file option using a memory buffer

Parameters:

	option	One of the values in FileOptions
	memory	Pointer to memory containing the entire file
	length	Number of bytes in the file

void BFOptionSet::SetOption	(	FileOptions	option,
		BFChannel *	channel
	)			`[inline]`

Sets a file option using a developer defined class derived from BFChannel

Parameters:

	option	One of the values in FileOptions
	channel	Pointer to an object derived from the BFChannel abstract base class. The developer continues to "own" this object and must gaurentee that this object is not deleted until after its Close member function is called.

void BFOptionSet::SetOption	(	HandlerOptions	option,
		BFElementHandler *	eh
	)			`[inline]`

Sets a element handler option using a developer defined class derived from BFElementHandler

Parameters:

	option	One of the values in HandlerOptions
	eh	Pointer to an object derived from the BFChannel abstract base class. The developer continues to "own" this object and must gaurentee that this object is not deleted until after its Close member function is called.

void BFOptionSet::SetOption	(	DirectoryOptions	option,
		const std::wstring &	path
	)			`[inline]`

Sets a directory option using a full path to the directory

Parameters:

	option	One of the values in DirectoryOptions
	path	A full path to the directory

void BFOptionSet::SetOption	(	ScrubOptions	option,
		ScrubOptionActions	action
	)			`[inline]`

Sets a scrub option

Parameters:

	option	One of the values in ScrubOptions
	action	One of the values in Actions

void BFOptionSet::SetOption	(	AnalyzeOptions	option,
		ScrubOptionActions	action
	)			`[inline]`

Sets an analyze option

Parameters:

	option	One of the values in AnalyzeOptions
	action	One of the values in Actions

void BFOptionSet::SetOption	(	FileFormatOptions	option,
		FileFormats	format
	)			`[inline]`

Sets a file format option

Parameters:

	option	One of the values in FileFormatOptions
	format	One of the values in FileFormats

void BFOptionSet::SetOption	(	FileFormatListOptions	option,
		FileFormats	formats[],
		int	count
	)			`[inline]`

Sets a file format list option

Parameters:

	option	One of the values in FileFormatListOptions
	formats	An array of FileFormats values
	count	The number of items in the values array

bool BFOptionSet::GetOption ( BooleanOptions option ) [inline]

Gets a boolean option

Parameters:

option

One of the values in BooleanOptions

Returns:: Value of the option

BFINT64 BFOptionSet::GetOption ( IntegerOptions option ) [inline]

Gets a integer option

Parameters:

option

One of the values in IntegerOptions

Returns:: Value of the option

void BFOptionSet::GetOption	(	StringOptions	option,
		std::wstring &	str
	)			`[inline]`

Gets a string option

Parameters:

	option	One of the values in StringOptions
	str	String that will receive the value of the option

void BFOptionSet::GetOption	(	FileOptions	option,
		std::wstring &	path
	)			`[inline]`

Gets a file option. This will only work on file options set using a file path. The results are unknown on file options set using memory or a BFChannel.

Parameters:

	option	One of the values in FileOptions
	path	String that will receive the path to the file

ScrubOptionActions BFOptionSet::GetOption ( ScrubOptions option ) [inline]

Gets a scrub option.

Parameters:

option

One of the values in ScrubOptions

Returns:: The value of the option. Will be one of the value in Actions.

ScrubOptionActions BFOptionSet::GetOption ( AnalyzeOptions option ) [inline]

Gets a analyze option.

Parameters:

option

One of the values in AnalyzeOptions

Returns:: The value of the option. Will be one of the value in Actions.

FileFormats BFOptionSet::GetOption ( FileFormatOptions option ) [inline]

Gets a file format option.

Parameters:

option

One of the values in FileFormatOptions

Returns:: The value of the option. Will be one of the value in FileFormats.

void BFOptionSet::GetOption	(	FileFormatListOptions	option,
		FileFormats	formats[],
		int *	count
	)			`[inline]`

Gets a file format list option

Parameters:

	option	One of the values in FileFormatListOptions
	formats	An array of FileFormats values
	count	count

void BFOptionSet::ReadOptionsFromXML ( std::wstring & path ) [inline]

Read options stored in an XML file. The file must have been previously saved using WriteOptionsToXML.

Parameters:

path

Full path to the XML file to read.

void BFOptionSet::WriteOptionsToXML ( std::wstring & path ) [inline]

Write the current options to an XML file.

Parameters:

path

Full path to the XML file to write.

Member Data Documentation

BFHANDLE BFOptionSet::request [protected]

Inheritance diagram for BFOptionSet:

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

secureapi.h

BFOptionSet Class Reference

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation