FLImagingCLR::CResult Class Reference

FLImaging module execution result object. More...

#include <ResultsDef.h>

Public Member Functions
	CResult ()
	Default constructor.
	CResult (const FLImaging::CResult &res)
	Copy constructor.
	CResult (const EResult eResult)
	Copy constructor.
const CResult ^	operator= (const FLImaging::CResult &res)
	Assign operator.
const CResult ^	operator= (EResult eResult)
	Assign operator.
bool	Assign (const FLImaging::CResult &res)
	Assign FLImaging::CResult object.
bool	Assign (const EResult eResult)
	Assign CResult object.
bool	Equal (const FLImaging::CResult &res)
	Compare FLImaging::CResult object.
bool	Equal (const EResult eResult)
	Compare CResult object.
bool	IsOK ()
	Check the success. If the result is OK or PartialOK, it returns true. otherwise, it returns false.
bool	IsStrictOK ()
	Check the success. If the result is OK, it returns true. otherwise, it returns false.
bool	IsFail ()
	Check the failure. If the result is not OK or PartialOK, it returns true. otherwise, it returns false.
bool	IsStrictFail ()
	Check the failure. If the result is not OK, it returns true. otherwise, it returns false.
int	GetResultCode ()
	Returns the result code.
System::String ^	GetString ()
	Get the result string.
const EResult	GetResult ()
	Result return enum.

Static Public Member Functions
static	operator const EResult (CResult^ res)
	Cast operator.
static bool	operator== (CResult^ br1, CResult^ br2)
	Comparison operator.
static bool	operator!= (CResult^ br1, CResult^ br2)
	Comparison operator.

Detailed Description

FLImaging module execution result object.

Constructor & Destructor Documentation

CResult() [1/2]

FLImagingCLR::CResult::CResult

(

const FLImaging::CResult &

res

)

Copy constructor.

Parameters

[in]

res

Copy instance

See also

FLImagingCLR::CResult

CResult() [2/2]

FLImagingCLR::CResult::CResult

(

const EResult

eResult

)

Copy constructor.

Parameters

[in]

eResult

Result enum

See also

FLImagingCLR::EResult

Member Function Documentation

Assign() [1/2]

bool FLImagingCLR::CResult::Assign

(

const EResult

eResult

)

Assign CResult object.

Parameters

[in]

eResult

Result enum

Return values

bool	succeed true failed false

See also

FLImagingCLR::EResult

Assign() [2/2]

bool FLImagingCLR::CResult::Assign

(

const FLImaging::CResult &

res

)

Assign FLImaging::CResult object.

Parameters

[in]

res

FLImaging::CResult object

Return values

bool	succeed true failed false

See also

FLImagingCLR::CResult

Equal() [1/2]

bool FLImagingCLR::CResult::Equal

(

const EResult

eResult

)

Compare CResult object.

Parameters

[in]

eResult

Result enum

Return values

bool	Equal true Not equal false

See also

FLImagingCLR::EResult

Equal() [2/2]

bool FLImagingCLR::CResult::Equal

(

const FLImaging::CResult &

res

)

Compare FLImaging::CResult object.

Parameters

[in]

res

FLImaging::CResult object.

Return values

bool	Equal true Not equal false

See also

FLImagingCLR::CResult

GetResult()

const EResult FLImagingCLR::CResult::GetResult

(

)

Result return enum.

Return values

FLImagingCLR::EResult

Result enum

See also

FLImagingCLR::EResult

GetResultCode()

int FLImagingCLR::CResult::GetResultCode

(

)

Returns the result code.

Return values

int	Result Code value

GetString()

System::String ^ FLImagingCLR::CResult::GetString

(

)

Get the result string.

Return values

System::String^

string pointer

IsFail()

bool FLImagingCLR::CResult::IsFail

(

)

Check the failure. If the result is not OK or PartialOK, it returns true. otherwise, it returns false.

Return values

bool	If the result is not OK or PartialOK, it returns true. otherwise, it returns false.

IsOK()

bool FLImagingCLR::CResult::IsOK

(

)

Check the success. If the result is OK or PartialOK, it returns true. otherwise, it returns false.

Return values

bool	If the result is OK or PartialOK, it returns true. otherwise, it returns false.

IsStrictFail()

bool FLImagingCLR::CResult::IsStrictFail

(

)

Check the failure. If the result is not OK, it returns true. otherwise, it returns false.

Return values

bool	If the result is not OK, it returns true. otherwise, it returns false.

IsStrictOK()

bool FLImagingCLR::CResult::IsStrictOK

(

)

Check the success. If the result is OK, it returns true. otherwise, it returns false.

Return values

bool	If the result is OK, it returns true. otherwise, it returns false.

operator const EResult()

static FLImagingCLR::CResult::operator const EResult ( CResult^ res )

static

Cast operator.

Parameters

[in]

res

CResult object

Return values

FLImagingCLR::EResult

Result enum

See also

FLImagingCLR::EResult

operator!=()

static bool FLImagingCLR::CResult::operator!= ( CResult^ br1, CResult^ br2 )

static

Comparison operator.

Parameters

[in]	br1	CResult object
[in]	br2	CResult object

Return values

bool	Not equal true Equal false

See also

FLImagingCLR::CResult

operator=() [1/2]

const CResult ^ FLImagingCLR::CResult::operator=

(

const FLImaging::CResult &

res

)

Assign operator.

Parameters

[in]

res

Input instance

Return values

FLImagingCLR::CResult^

CResult

See also

FLImagingCLR::CResult

operator=() [2/2]

const CResult ^ FLImagingCLR::CResult::operator=

(

EResult

eResult

)

Assign operator.

Parameters

[in]

eResult

Result enum

Return values

FLImagingCLR::CResult^

CResult

See also

FLImagingCLR::EResult

operator==()

static bool FLImagingCLR::CResult::operator== ( CResult^ br1, CResult^ br2 )

static

Comparison operator.

Parameters

[in]	br1	CResult object
[in]	br2	CResult object

Return values

bool	Equal true Not equal false

See also

FLImagingCLR::CResult