NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::IExport_result Class Referenceabstract

This interface represents the result of an export operation. More...

Inheritance diagram for mi::IExport_result:
Inheritance graph
[legend]

Public Member Functions

virtual Uint32  get_error_number () const =0
  Returns the number of the first error. More...
 
virtual const char *  get_error_message () const =0
  Returns the message of the first error. More...
 
virtual Size  get_messages_length () const =0
  Returns the number of messages. More...
 
virtual Uint32  get_message_number (Size index) const =0
  Returns the message number for a given message from the array of messages. More...
 
virtual const char *  get_message (Size index) const =0
  Returns a message from the array of messages. More...
 
virtual base::Message_severity  get_message_severity (Size index) const =0
  Returns the severity for a given message from the array of messages. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xb900251e, 0x34e9, 0x4a56, 0x83, 0x77, 0x69, 0x97, 0x69, 0x6b, 0x82, 0x84 >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
Self
  Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
  Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xb900251e, 0x34e9, 0x4a56, 0x83, 0x77, 0x69, 0x97, 0x69, 0x6b, 0x82, 0x84 >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

This interface represents the result of an export operation.

Such an export operation is triggered by mi::neuraylib::IExport_api::export_elements() or mi::neuraylib::IExport_api::export_scene(). It gives access to messages, message numbers, and and message severities.

Exporters should use the message severities according to the following guidelines:

Member Function Documentation

virtual const char* mi::IExport_result::get_error_message ( ) const
pure virtual

Returns the message of the first error.

A message describing the error condition corresponding to the error reported from get_error_number().

It is possible to query the all messages, see get_messages_length() and get_message(mi::Size)const. This method just reports the the first message of severity mi::base::MESSAGE_SEVERITY_ERROR or above, or NULL if there is no such message.

virtual Uint32 mi::IExport_result::get_error_number ( ) const
pure virtual

Returns the number of the first error.

The error number indicates the status of the import operation: 0 means success, all other values indicate failures, in which case get_error_message() provides a diagnostic message. Numbers in the range 4000-5999 are reserved for custom importers. All other numbers are reserved for other purposes.

It is possible to query the message numbers of all messages, see get_messages_length() and get_message_number(mi::Size)const. This method just reports the number of the first message of severity mi::base::MESSAGE_SEVERITY_ERROR or above, or 0 if there is no such message.

virtual const char* mi::IExport_result::get_message ( Size  index) const
pure virtual

Returns a message from the array of messages.

see get_messages_length()

virtual Uint32 mi::IExport_result::get_message_number ( Size  index) const
pure virtual

Returns the message number for a given message from the array of messages.

see get_messages_length()

virtual base::Message_severity mi::IExport_result::get_message_severity ( Size  index) const
pure virtual

Returns the severity for a given message from the array of messages.

see get_messages_length()

virtual Size mi::IExport_result::get_messages_length ( ) const
pure virtual

Returns the number of messages.