mi::neuraylib::IExport_result_ext Class Reference
[Importer and Exporter]
Description
This interface represents the result of an export operation. It is derived from the mi::neuraylib::IExport_result interface and is intended to be used by exporter writers. In addition to the mi::neuraylib::IExport_result interface it provides methods to set all values.
See mi::neuraylib::IExport_api::export_scene() and mi::neuraylib::IExport_api::export_elements() for common message numbers. Numbers in the range 6000-7999 are reserved for exporter-specific messages. All other numbers are reserved for other purposes.
In case of a successful export operation the array of messages should not contain an explicit message with message number 0. If there are no other exporter-specific messages, messages, the message array should then just be empty, such that mi::neuraylib::IExport_result::get_error_number() returns 0 and mi::neuraylib::IExport_result::get_error_message() returns NULL.
Public Member Functions
- virtual Sint32 append_messages( const IExport_result* export_result) =0
- Appends all messages in export_result to this instance. More...
- virtual void clear_messages() =0
- Removes all messages.
- virtual Sint32 message_push_back( Uint32 number, base::Message_severity severity, const char* message) =0
- Appends a message number, severity, and message to the array of recorded message numbers, severities, and messages. More...
- virtual Sint32 set_message( Uint32 number, base::Message_severity severity, const char* message) =0
- Replaces all messages by the given message number, severity, and message. More...
- virtual Sint32 set_message( Size index, Uint32 number, base::Message_severity severity, const char* message) =0
- Replaces a message number, severity, and message in the array of recorded message numbers, severities, and messages. More...
Member Functions
- virtual Sint32 mi::neuraylib::IExport_result_ext::append_messages( const IExport_result* export_result) [pure virtual]
-
Appends all messages in export_result to this instance.
Returns
- 0: Success.
- -1: Invalid parameters (NULL pointer).
- virtual void mi::neuraylib::IExport_result_ext::clear_messages() [pure virtual]
-
Removes all messages.
- virtual Sint32 mi::neuraylib::IExport_result_ext::message_push_back( Uint32 number, base::Message_severity severity, const char* message) [pure virtual]
-
Appends a message number, severity, and message to the array of recorded message numbers, severities, and messages.
See also:
mi::neuraylib::IExport_result_ext for valid message numbers
Parameters
- number
- The message number to append.
- severity
- The message severity to append.
- message
- The message to append.
Returns
- 0: Success.
- -1: Invalid parameters (NULL pointer).
- virtual Sint32 mi::neuraylib::IExport_result_ext::set_message( Uint32 number, base::Message_severity severity, const char* message) [pure virtual]
-
Replaces all messages by the given message number, severity, and message. Equivalent to clear_messages(), followed by message_push_back().
See also:
mi::neuraylib::IExport_result_ext for valid message numbers
Returns
- 0: Success.
- -1: Invalid parameters (NULL pointer).
- virtual Sint32 mi::neuraylib::IExport_result_ext::set_message( Size index, Uint32 number, base::Message_severity severity, const char* message) [pure virtual]
-
Replaces a message number, severity, and message in the array of recorded message numbers, severities, and messages.
See also:
mi::neuraylib::IExport_result_ext for valid message numbers
Parameters
- index
- The index of the message to be replaced.
- number
- The message number to append.
- severity
- The message severity to append.
- message
- The message to append.
Returns
- 0: Success.
- -1: Invalid parameters (NULL pointer).
- -2: index is out of bounds.