integra_api::CLoadCommandResult Class Reference

Represents return information for ILoadCommand. More...

#include "api/command_result.h"

Inheritance diagram for integra_api::CLoadCommandResult:

Collaboration diagram for integra_api::CLoadCommandResult:

Public Member Functions
const guid_set &	get_new_embedded_module_ids () const
	retrieve the ids of new embedded modules More...
void	set_new_embedded_module_ids (const guid_set &ids)
	internal use only

Detailed Description

Represents return information for ILoadCommand.

Allows users of ILoadCommand to obtain guids of any newly loaded embedded modules

Member Function Documentation

const guid_set& integra_api::CLoadCommandResult::get_new_embedded_module_ids ( ) const

inline

retrieve the ids of new embedded modules

If the loaded file contains embedded modules that are not already present in the current IntegraSession, these modules are loaded with a module_source of MODULE_EMBEDDED (see IInterfaceDefinition). The guids of these new modules can be obtained here. Reasons embedded modules might be loaded: Loading a project which contains older versions of shipped-with-libIntegra modules Loading a project which contains modules that were shipped with older versions of libIntegra, but no longer shipped Loading a project which contains 3rd party modules not present on this system Loading a project which contains older/newer/different versions of 3rd party modules that are present on this system

Returns

a reference to the set of new embedded module guids, or an empty set if the command failed (or was a different type of command)

---

The documentation for this class was generated from the following file:

• /Users/jamie/Documents/IntegraLive/libIntegra/api/command_result.h