Ort::Status Struct Reference

The Status that holds ownership of OrtStatus received from C API Use it to safely destroy OrtStatus* returned from the C API. Use appropriate constructors to construct an instance of a Status object from exceptions. More...

#include <onnxruntime_cxx_api.h>

Inheritance diagram for Ort::Status:

Public Member Functions
	Status (std::nullptr_t) noexcept
	Create an empty object, must be assigned a valid one to be used. More...
	Status (OrtStatus *status) noexcept
	Takes ownership of OrtStatus instance returned from the C API. More...
	Status (const Exception &) noexcept
	Creates status instance out of exception. More...
	Status (const std::exception &) noexcept
	Creates status instance out of exception. More...
	Status (const char *message, OrtErrorCode code) noexcept
	Creates status instance out of null-terminated string message. More...
std::string	GetErrorMessage () const
OrtErrorCode	GetErrorCode () const
bool	IsOK () const noexcept
	Returns true if instance represents an OK (non-error) status. More...
Public Member Functions inherited from Ort::detail::Base< OrtStatus >
constexpr	Base ()=default
constexpr	Base (contained_type *p) noexcept
	Base (const Base &)=delete
	Base (Base &&v) noexcept
	~Base ()
Base &	operator= (const Base &)=delete
Base &	operator= (Base &&v) noexcept
constexpr	operator contained_type * () const noexcept
contained_type *	release ()
	Relinquishes ownership of the contained C object pointer The underlying object is not destroyed. More...

Additional Inherited Members
Public Types inherited from Ort::detail::Base< OrtStatus >
using	contained_type = OrtStatus
Protected Attributes inherited from Ort::detail::Base< OrtStatus >
contained_type *	p_

Detailed Description

The Status that holds ownership of OrtStatus received from C API Use it to safely destroy OrtStatus* returned from the C API. Use appropriate constructors to construct an instance of a Status object from exceptions.

Definition at line 652 of file onnxruntime_cxx_api.h.

Constructor & Destructor Documentation

Ort::Status::Status ( std::nullptr_t  )

inlineexplicitnoexcept

Create an empty object, must be assigned a valid one to be used.

Definition at line 653 of file onnxruntime_cxx_api.h.

Ort::Status::Status ( OrtStatus *  status )

inlineexplicitnoexcept

Takes ownership of OrtStatus instance returned from the C API.

Definition at line 54 of file onnxruntime_cxx_inline.h.

Ort::Status::Status ( const Exception &  )

explicitnoexcept

Creates status instance out of exception.

Ort::Status::Status ( const std::exception &  )

explicitnoexcept

Creates status instance out of exception.

Ort::Status::Status ( const char *  message, OrtErrorCode  code  )

noexcept

Creates status instance out of null-terminated string message.

Member Function Documentation

OrtErrorCode Ort::Status::GetErrorCode

(

)

const

std::string Ort::Status::GetErrorMessage

(

)

const

bool Ort::Status::IsOK ( ) const

noexcept

Returns true if instance represents an OK (non-error) status.

---

The documentation for this struct was generated from the following files:

• onnxruntime/core/session/onnxruntime_cxx_api.h
• onnxruntime/core/session/onnxruntime_cxx_inline.h