neuray API Programmer's Manual

mi::neuraylib::IMdl_compatibility_api Class Reference

[Miscellaneous MDL-related Interfaces]

Description

Provides access to various functions to inspect the compatibility between MDL modules and archives.

Public Member Functions

virtual Sint32 compare_archives( const char* archive_fname1, const char* archive_fname2, const IArray* search_paths, IMdl_execution_context* context) const =0
Compares two archives for compatibility. More...
virtual Sint32 compare_modules( const char* module_name, const char* repl_file_name, const IArray* search_paths, IMdl_execution_context* context) const =0
Compares one original module with an replacement module for compatibility. More...

Member Functions

virtual Sint32 mi::​neuraylib::​IMdl_compatibility_api::compare_archives( const char* archive_fname1, const char* archive_fname2, const IArray* search_paths, IMdl_execution_context* context) const [pure virtual]

Compares two archives for compatibility.

Parameters

archive_fname1
Path to first archive.
archive_fname2
Path to second archive.
search_paths
An optional array of additional search paths to consider for archive_fname2.
context
An execution context. If non-null, the context can be queried for messages after the comparison operation has finished.

Returns

  • 0: The archives are compatible.
  • -1: Invalid parameters (NULL pointer).
  • -2: An error occurred during archive comparison. Please check the context for details.

virtual Sint32 mi::​neuraylib::​IMdl_compatibility_api::compare_modules( const char* module_name, const char* repl_file_name, const IArray* search_paths, IMdl_execution_context* context) const [pure virtual]

Compares one original module with an replacement module for compatibility.

Parameters

module_name
The absolute name of the original module.
repl_file_name
Path to the replacement module.
search_paths
An optional array of additional search paths to consider for repl_file_name.
context
An execution context. If non-null, the context can be queried for messages after the comparison operation has finished.

Returns

  • 0: The modules are compatible.
  • -1: Invalid parameters (NULL pointer).
  • -2: An error occurred during module comparison. Please check the context for details.