N2N::ReturnStatus Struct Reference

Information about the completion status of a method. More...

#include <n2n.h>

Public Member Functions
	ReturnStatus ()=default
	Constructor.
	ReturnStatus (const StatusCode code, const std::string info)
	Constructor. More...

Public Attributes
StatusCode	code {StatusCode::Success}
	Completion status of the returning method.
std::string	info {}
	Additional clarifying information about code.

Detailed Description

Information about the completion status of a method.

An object of this class allows the software to return some information from a method call. The string within this object can be optionally set to provide more information for debugging. The status code will be set by the function to Success on success, or one of the other codes on failure. In failure cases, processing will proceed with further calls to the function.

Note

If the SDK encounters a non-recoverable error, an exception should be thrown and processing will stop.

Constructor & Destructor Documentation

ReturnStatus()

N2N::ReturnStatus::ReturnStatus ( const StatusCode  code, const std::string  info  )

inline

Constructor.

Parameters

[in]	code	The return status code.
[in]	info	The optional information string.