Diarkis C++Client Library API Document
Public Member Functions | List of all members
Diarkis::DiarkisSuccessEventArgs Struct Reference

Arguments of the callback event called when joining or leaving a Field. More...

#include <eventArgs.h>

Public Member Functions

bool IsSuccess () const
 Get whether the command was successful or not. More...
 
uint16_t GetErrorCode () const
 Get error code. More...
 
const Diarkis::StdString & GetErrorMessage () const
 Gets the contents of the error. More...
 
 DiarkisSuccessEventArgs (bool isSuccess_, uint16_t errorCode, const Diarkis::StdString &errorString)
 
 DiarkisSuccessEventArgs (DiarkisSuccessEventArgs &)=delete
 
 DiarkisSuccessEventArgs (DiarkisSuccessEventArgs &&)=delete
 

Detailed Description

Arguments of the callback event called when joining or leaving a Field.

Constructor & Destructor Documentation

◆ DiarkisSuccessEventArgs() [1/3]

Diarkis::DiarkisSuccessEventArgs::DiarkisSuccessEventArgs ( bool  isSuccess_,
uint16_t  errorCode,
const Diarkis::StdString &  errorString 
)

◆ DiarkisSuccessEventArgs() [2/3]

Diarkis::DiarkisSuccessEventArgs::DiarkisSuccessEventArgs ( DiarkisSuccessEventArgs &  )
delete

◆ DiarkisSuccessEventArgs() [3/3]

Diarkis::DiarkisSuccessEventArgs::DiarkisSuccessEventArgs ( DiarkisSuccessEventArgs &&  )
delete

Member Function Documentation

◆ IsSuccess()

bool Diarkis::DiarkisSuccessEventArgs::IsSuccess ( ) const

Get whether the command was successful or not.

true=success false=failure

Here is the caller graph for this function:

◆ GetErrorCode()

uint16_t Diarkis::DiarkisSuccessEventArgs::GetErrorCode ( ) const

Get error code.

Return 0 if IsSuccess()=true.

Here is the caller graph for this function:

◆ GetErrorMessage()

const Diarkis::StdString& Diarkis::DiarkisSuccessEventArgs::GetErrorMessage ( ) const

Gets the contents of the error.

Here is the caller graph for this function:
The documentation for this struct was generated from the following file: