Response processing

---

Description

Functions to deal with the response provided by BFGetSecureResponse()

Functions
BFEXPORT_FUNCDEC int	BFCloseSecureResponse (const BFHANDLE response, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetScrubResult (const BFHANDLE response, const enum ScrubOptions option, enum ScrubOptionReactions *result, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetAnalyzeResult (const BFHANDLE response, const enum AnalyzeOptions option, enum ScrubOptionReactions *reaction, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetBooleanResult (const BFHANDLE response, const enum BooleanOptions option, int *result, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetEnumResult (const BFHANDLE response, const enum EnumOptions option, int *result, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileFormatResult (const BFHANDLE response, const enum FileFormatOptions option, enum FileFormats *format, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFCompareResponse (const BFHANDLE response1, const BFHANDLE response2, BFHANDLE *errorinfo)

---

Function Documentation

BFEXPORT_FUNCDEC int BFCloseSecureResponse	(	const BFHANDLE	response,
		BFHANDLE *	errorinfo
	)

Destory a secure response. The response should never again be used after this function returns.

Parameters:

	response	BFHANDLE response to be closed
	errorinfo	Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available.

Returns:

One of the BFRESULT codes

BFEXPORT_FUNCDEC int BFGetScrubResult	(	const BFHANDLE	response,
		const enum ScrubOptions	option,
		enum ScrubOptionReactions *	result,
		BFHANDLE *	errorinfo
	)

Gets a scrub result from a response.

Parameters:

	response	BFHANDLE that represents the response
	option	One of the values in ScrubOptions
	result	Pointer to an Reactions that will receive the value
	errorinfo	Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available.

Returns:

One of the BFRESULT codes

BFEXPORT_FUNCDEC int BFGetAnalyzeResult	(	const BFHANDLE	response,
		const enum AnalyzeOptions	option,
		enum ScrubOptionReactions *	reaction,
		BFHANDLE *	errorinfo
	)

Gets an analyze result from a response.

Parameters:

	response	BFHANDLE that represents the response
	option	One of the values in AnalyzeOptions
	reaction	Pointer to an Reactions that will receive the value. Note since this is an analyze result the reaction will never be ScrubbedReaction.
	errorinfo	Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available.

Returns:

One of the BFRESULT codes

BFEXPORT_FUNCDEC int BFGetBooleanResult	(	const BFHANDLE	response,
		const enum BooleanOptions	option,
		int *	result,
		BFHANDLE *	errorinfo
	)

Gets a boolean result from a response.

Parameters:

	response	BFHANDLE that represents the response
	option	One of the values in BooleanOptions
	result	Pointer to an int that will receive either BFTRUE or BFFALSE
	errorinfo	Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available.

Returns:

One of the BFRESULT codes

BFEXPORT_FUNCDEC int BFGetEnumResult	(	const BFHANDLE	response,
		const enum EnumOptions	option,
		int *	result,
		BFHANDLE *	errorinfo
	)

Gets an enumeration result from a response.

Parameters:

	response	BFHANDLE that represents the response
	option	One of the values in EnumOptions
	result	Pointer to an int that will receive the value
	errorinfo	Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available.

Returns:

One of the BFRESULT codes

BFEXPORT_FUNCDEC int BFGetFileFormatResult	(	const BFHANDLE	response,
		const enum FileFormatOptions	option,
		enum FileFormats *	format,
		BFHANDLE *	errorinfo
	)

Gets a file format result from a response.

Parameters:

	response	BFHANDLE that represents the response
	option	One of the values in FileFormatOptions
	format	Pointer to an FileFormats that will receive the value.
	errorinfo	Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available.

Returns:

One of the BFRESULT codes

BFEXPORT_FUNCDEC int BFCompareResponse	(	const BFHANDLE	response1,
		const BFHANDLE	response2,
		BFHANDLE *	errorinfo
	)

Compare two responses. This function is exposed primarily for testing purposes.

Parameters:

	response1	BFHANDLE that represents a response
	response2	BFHANDLE that represents a response
	errorinfo	Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available.

Returns:

BFTRUE if the responses contain all the same values, BFFALSE otherwise