内容表

• 关于
• Result
• Result Class
• Special Classes
• 延伸阅读

关于

The error reporting system of the MAXON API is based on the maxon::Result template. Such a maxon::Result object can contain both the actual return value of the function and an error object if an error had occurred.

结果

These default error values are used to check if a maxon::Result object contains an error or not:

• maxon::OK : No error had occurred.
• maxon::FAILED : An error had occurred.

注意

maxon::OK can be used as a return value. But it is not possible to use maxon::FAILED as a return value. A proper error object must be returned instead.

The return value of a function returning maxon::Result<void> should be documented as "OK on success".

// This example shows a function that does not return a value // but can return an error in case of an invalid argument or just maxon::OK. // Note: Real code should use a reference and not a pointer.

//---------------------------------------------------------------------------------------- // Increments the given maxon::Int value. // Returns an NullptrError if an invalid argument is given. // @param[in,out] number Pointer to an maxon::Int value. // @return OK on success. //---------------------------------------------------------------------------------------- static maxon::Result<void> IncrementValue( maxon::Int * const number) { if (number == nullptr ) return maxon::NullptrError( MAXON_SOURCE_LOCATION );