Inherits IDispatch.

Detailed Description

Interface for VSTA control

 
    interface IVstaIntegration : IDispatch
    {
        HRESULT Connect([in] IOMAgent* pCanDll);
        HRESULT Disconnect();
        HRESULT NewAddIn([in] BSTR sPath, [in] enum AddInLanguage enLang);
        HRESULT LoadAddIn([in] BSTR sPath);
        HRESULT UnloadAddIn([in] BSTR sPath);
        HRESULT ShowIde([in] VARIANT_BOOL boShow);
        HRESULT CallGotDirtyOnFilechanges([out, retval] VARIANT_BOOL* boCall);
        HRESULT CallGotDirtyOnFilechanges([in] VARIANT_BOOL boCall);
        HRESULT GetAddIns([out] VARIANT* pAddInPaths);
        HRESULT CleanDirty();
        HRESULT Dirty([out, retval] VARIANT_BOOL* pAddInPaths);
        HRESULT StartAddIn([in] BSTR sPath);
        HRESULT StopAddIn([in] BSTR sPath);
        HRESULT GetAddInStatus([in] BSTR sPath, [out] enum AddInStatus* pStatus);
        HRESULT SaveDirtyAddIns();
        HRESULT StartAddInExt([in] BSTR sPath, [out] VARIANT * sMacroNames);
        HRESULT StartMacro([in] BSTR sPath, [in] BSTR sMacroName, [in] LONG hParentWindow);
    };
 

Definition at line 8472 of file cand_tlb.idl.

Member Function Documentation

◆ CleanDirty()

HRESULT CanEasy::IVstaIntegration::CleanDirty ( )

Cleans up the dirty flag

◆ Connect()

HRESULT CanEasy::IVstaIntegration::Connect ( [in] IOMAgent * pCanDll )

Connects to IOMAgent

◆ Disconnect()

HRESULT CanEasy::IVstaIntegration::Disconnect ( )

Disconnects

◆ GetAddIns()

HRESULT CanEasy::IVstaIntegration::GetAddIns ( [out] VARIANT * pAddInPaths )

Returns the path to the add-ins

◆ GetAddInStatus()

HRESULT CanEasy::IVstaIntegration::GetAddInStatus	(	[in] BSTR	sPath,
		[out] enum AddInStatus *	pStatus
	)

Returns the status of passed add-in

Parameters

	sPath	Path to the add-in
[out]	pStatus	Status of the add-in

◆ LoadAddIn()

HRESULT CanEasy::IVstaIntegration::LoadAddIn ( [in] BSTR sPath )

Loads an existing add-in

Parameters

sPath Path to the add-in

◆ NewAddIn()

HRESULT CanEasy::IVstaIntegration::NewAddIn	(	[in] BSTR	sPath,
		[in] enum AddInLanguage	enLang
	)

Creates a new add-in

Parameters

sPath	Path to the add-in
enLang	Language to use

◆ SaveDirtyAddIns()

HRESULT CanEasy::IVstaIntegration::SaveDirtyAddIns ( )

Save addins with dirty flag

◆ ShowIde()

HRESULT CanEasy::IVstaIntegration::ShowIde ( [in] VARIANT_BOOL boShow )

Shows/Hides the IDE

◆ StartAddIn()

HRESULT CanEasy::IVstaIntegration::StartAddIn ( [in] BSTR sPath )

Starts the passed add-in

Parameters

sPath Path to the add-in

◆ StartAddInExt()

HRESULT CanEasy::IVstaIntegration::StartAddInExt	(	[in] BSTR	sPath,
		[out] VARIANT *	sMacroNames
	)

Starts the add-in and returns list of its macros names. When an add-in keeps running, its macro (static method) can be started

Parameters

	sPath	Path to the add-in
[out]	sMacroNames	BSTR Array with macro names

◆ StartMacro()

HRESULT CanEasy::IVstaIntegration::StartMacro	(	[in] BSTR	sPath,
		[in] BSTR	sMacroName,
		[in] LONG	hParentWindow
	)

Starts add-in's macro determined by sPath path string. Before the start an add-in must be started with StartAddInExt function. If macro requires input parameters and/or returns a value, a modal dialog will be shown with hParentWindow as parent.

Parameters

sPath	Path to the add-in
sMacroName	Macro to start
hParentWindow	HWND to the CanEasy main window

◆ StopAddIn()

HRESULT CanEasy::IVstaIntegration::StopAddIn ( [in] BSTR sPath )

Stops the passed add-in

Parameters

sPath Path to the add-in

◆ UnloadAddIn()

HRESULT CanEasy::IVstaIntegration::UnloadAddIn ( [in] BSTR sPath )

Unloads an add-in

Parameters

sPath Path to the add-in

Property Documentation

◆ CallGotDirtyOnFilechanges

VARIANT_BOOL CanEasy::IVstaIntegration::CallGotDirtyOnFilechanges

getset

Activates/Deactivates events for file changes

◆ Dirty

VARIANT_BOOL CanEasy::IVstaIntegration::Dirty

get

Returns the dirty flag