BFSecureResponse Class Reference


Description

An object that represents the response to execution of a BFSecureRequest::Execute. The constructor for this class is private because instances should only be retrieved through BFSecureRequest::GetSecureResponse.

#include <secureapi.h>

List of all members.

Public Member Functions

 ~BFSecureResponse ()
bool GetBooleanResult (BooleanOptions option)
int GetEnumResult (EnumOptions option)
ScrubOptionReactions GetScrubResult (ScrubOptions option)
ScrubOptionReactions GetAnalyzeResult (AnalyzeOptions option)
FileFormats GetFileFormatResult (FileFormatOptions option)

Friends

class BFSecureRequest

Constructor & Destructor Documentation

BFSecureResponse::~BFSecureResponse (  )  [inline]

Destroys a BFSecureResponse object.


Member Function Documentation

bool BFSecureResponse::GetBooleanResult ( BooleanOptions  option  )  [inline]

Gets a boolean result from a response.

Parameters:
option One of the values in BooleanOptions
Returns:
true or false
int BFSecureResponse::GetEnumResult ( EnumOptions  option  )  [inline]

Gets a enum result from a response.

Parameters:
option One of the values in EnumOptions
Returns:
integer value
ScrubOptionReactions BFSecureResponse::GetScrubResult ( ScrubOptions  option  )  [inline]

Gets a scrub result

Parameters:
option One of the values in ScrubOptions
Returns:
One of the values in Reactions
ScrubOptionReactions BFSecureResponse::GetAnalyzeResult ( AnalyzeOptions  option  )  [inline]

Gets a analyze result

Parameters:
option One of the values in AnalyzeOptions
Returns:
One of the values in Reactions
FileFormats BFSecureResponse::GetFileFormatResult ( FileFormatOptions  option  )  [inline]

Gets a file format result

Parameters:
option One of the values in FileFormatOptions
Returns:
One of the values in FileFormats

Friends And Related Function Documentation

friend class BFSecureRequest [friend]

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Clean Content C/C++ API 8.5.6.01.211123 documentation generated on Tue Nov 23 02:25:23 2021 by Doxygen 1.6.3