mi::IExport_result_ext Class Reference

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

Inheritance diagram for mi::IExport_result_ext:

Public Member Functions
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	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 (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...
virtual void	clear_messages ()=0
	Removes all messages. More...
virtual Sint32	append_messages (const IExport_result *export_result)=0
	Appends all messages in export_result to this instance. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0xfbf13ba1, 0x7310, 0x4e1a, 0x80, 0x0a, 0x88, 0xc4, 0x20, 0x3e, 0xad, 0x96, IExport_result >
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IExport_result >	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< 0xfbf13ba1, 0x7310, 0x4e1a, 0x80, 0x0a, 0x88, 0xc4, 0x20, 0x3e, 0xad, 0x96, IExport_result >
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.

It is derived from the mi::IExport_result interface and is intended to be used by exporter writers. In addition to the mi::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.

Note

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::IExport_result::get_error_number() returns 0 and mi::IExport_result::get_error_message() returns NULL.

Member Function Documentation

virtual Sint32 mi::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::IExport_result_ext::clear_messages ( )

pure virtual

Removes all messages.

virtual Sint32 mi::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.

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).

See Also

mi::IExport_result_ext for valid message numbers

virtual Sint32 mi::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().

Returns

• 0: Success.
• -1: Invalid parameters (NULL pointer).

See Also

mi::IExport_result_ext for valid message numbers

virtual Sint32 mi::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.

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.

See Also

mi::IExport_result_ext for valid message numbers