A class for retrieving the result of some operation. More...

#include "murl_result.h"

Public Member Functions

 Result ()
 The default constructor.
 
void SetOk ()
 Set success.
 
void SetError ()
 Set an unspecified error.
 
void Set (IEnums::ResultCode code)
 Set a result code without a message. More...
 
void Set (const Char *message,...)
 Set a result message. More...
 
void Set (IEnums::ResultCode code, const Char *message,...)
 Set a result code and message. More...
 
void Append (const Char *message,...)
 Append a result message. More...
 
Bool IsOk () const
 Check if the contained result is OK. More...
 
Bool IsError () const
 Check if the contained result represents an error. More...
 
IEnums::ResultCode GetCode () const
 Get the result code. More...
 
const StringGetMessage () const
 Get the result message. More...
 

Detailed Description

A class for retrieving the result of some operation.

Member Function Documentation

◆ Set() [1/3]

void Murl::Result::Set ( IEnums::ResultCode  code)

Set a result code without a message.

Parameters
codeThe result code.

◆ Set() [2/3]

void Murl::Result::Set ( const Char message,
  ... 
)

Set a result message.

Parameters
messageThe message.

◆ Set() [3/3]

void Murl::Result::Set ( IEnums::ResultCode  code,
const Char message,
  ... 
)

Set a result code and message.

Parameters
codeThe result code.
messageThe message.

◆ Append()

void Murl::Result::Append ( const Char message,
  ... 
)

Append a result message.

Parameters
messageThe message.

◆ IsOk()

Bool Murl::Result::IsOk ( ) const

Check if the contained result is OK.

Returns
true if OK.

◆ IsError()

Bool Murl::Result::IsError ( ) const

Check if the contained result represents an error.

Returns
true if error.

◆ GetCode()

IEnums::ResultCode Murl::Result::GetCode ( ) const

Get the result code.

Returns
The result code.

◆ GetMessage()

const String& Murl::Result::GetMessage ( ) const

Get the result message.

Returns
The result message.

The documentation for this class was generated from the following file:
  • murl_result.h


Copyright © 2011-2018 Spraylight GmbH.