Inherits IDispatch.

Detailed Description

Application interface which allows to access CanEasy functions like Database.

Created in another process allows to integrate CanEasy into another process.

 
    interface ICanEasyApplication : IDispatch
    {
        HRESULT StartSimulation();
        HRESULT StopSimulation();
        HRESULT Database([out, retval] IDatabase **pVal);        
        HRESULT Sleep([in] long nPeriod);
        HRESULT ScreenUpdate([out, retval] VARIANT_BOOL *pVal);
        HRESULT ScreenUpdate([in] VARIANT_BOOL boNewVal);
         //VSTAHidden
        HRESULT RegisterExtension([in] BSTR sID, [in] IExtension* iExtension);
        HRESULT Extension([in] BSTR sID, [out, retval] IDispatch* *pVal);
         //VSTAHidden
        HRESULT UnregisterExtension([in] BSTR sID);
        HRESULT SimulationIsRunning([out, retval] VARIANT_BOOL* pVal);
        HRESULT Simulation([out, retval] ISimulation **pVal);
        HRESULT VarDatabase([out, retval] IEnvVarDatabase **pItem);
        HRESULT WorkspacePath([out, retval] BSTR *pBSTR);
        HRESULT Workspace([out, retval] BSTR *pBSTR);
        HRESULT HardwareNames([out, retval] VARIANT* pNames);
        HRESULT MakeReport([in] BSTR sReportText, [in] enum ReportType enType);
        HRESULT Record([out, retval] IRecord** ppRecord);
        HRESULT Application([out, retval] ICanEasyApplication** ppApp);
        HRESULT Vba([out, retval] IDispatch** ppExtension);
        HRESULT CanoePanels([out, retval] ICANoePanelFactory** ppExtension);             
        HRESULT RecursivEvents([out, retval] VARIANT_BOOL *pVal);
        HRESULT RecursivEvents([in] VARIANT_BOOL boNewVal);
        HRESULT VBACompatible([out, retval] VARIANT_BOOL* pVal);
        HRESULT VBACompatible([in] VARIANT_BOOL boVal);
        HRESULT MakeExtendedId([in] long lMsgId, [out, retval] long*);
        HRESULT MakeStandardId([in] long lMsgId, [out, retval] long*);
        HRESULT IsExtendedId([in] long lMsgId, [out, retval] VARIANT_BOOL*);
        HRESULT GetAbsFilePath([in] BSTR sAbsPath, [in] BSTR sRelPath, [out, retval] BSTR*);
        HRESULT Version([out, retval] BSTR* pVersion);
        HRESULT ReportWndCol([out, retval] IReportWndCol**);
        HRESULT Init();
        HRESULT DeInit();
        HRESULT Start();
        HRESULT LoadWorkspace([in] BSTR sFile);
        HRESULT CreateObjectFilter([out, retval] IObjectFilter** ppFilter);
 
        HRESULT StartInternal();
        HRESULT License([out, retval] ILicense** ppLicense);
        HRESULT CreateWorkspaceModule([in] BSTR sModuleName, [out, retval] IWorkspaceModule**);
 
        HRESULT Tree([out, retval] ICanEasyTree **pTree);
        HRESULT Replay([out, retval] IReplayCol **pReplayCol);            
        HRESULT CreateSelection([out, retval] ISelection** ppItem);
        HRESULT CreateTimerControl([out, retval] ITimerControl** ppItem);
        HRESULT CreateTxConfirm([out, retval] ITxConfirm** ppItem);
        HRESULT CreateRxConfirm([out, retval] IRxConfirm** ppItem);
        HRESULT CreatePreTransmit([out, retval] IPreTransmit** ppItem);
        HRESULT CreatePreCopy([out, retval] IPreCopy** ppItem);
        HRESULT SaveWorkspace([in] BSTR sFile);
        HRESULT NewWorkspace();
        HRESULT AppWindow([out, retval] IAppWindow** pVal);
        HRESULT CreateCaptureTimer([out, retval] ICaptureTimer** pItem);
        HRESULT CreateCompareTimer([out, retval] ICompareTimer** pItem);
        HRESULT ShowDisclaimer([out, retval] VARIANT_BOOL* pVal);
        HRESULT Hardware([out, retval] IHardware** pItem);      
        HRESULT VirtualChannels([out, retval] IVirtualChannelCol** ppCol);      
 
        HRESULT WritePort([in] long lAddr, [in] long lVal);
        HRESULT ReadPort([in] long lAddr, [out, retval] long* pVal);
         HRESULT CreateSerialPort([out, retval] ISerialPort** pVal);
         HRESULT Transmit([in] IDatabaseItem* pItem);
        HRESULT Quit();
        HRESULT CreateDatabaseItem([out, retval] IDatabaseItemBase** ppItem);
         HRESULT CalculateKey([in] BSTR dll, [in] long secLevel, [in] BSTR variant, [in] VARIANT seed, [out, retval] VARIANT*);
         HRESULT CalculateKeyOpt([in] BSTR dll, [in] long secLevel, [in] BSTR variant, [in] BSTR option, [in] VARIANT seed, [out, retval] VARIANT*);
        HRESULT CAPL([out, retval] ICAPL** ppCAPL);
        HRESULT WriteSetting([in] BSTR sName, [in] VARIANT_BOOL iniFile, [in] BSTR sVal);
        HRESULT ReadSetting([in] BSTR sName, [in] VARIANT_BOOL iniFile, [out, retval] BSTR*);
        HRESULT TransmitStringData([in] BSTR sRef, [in] BSTR data, [out, retval] BSTR*);
        HRESULT Flash([in] BSTR sProps, [out, retval] long*);
    };       
 

Definition at line 7635 of file cand_tlb.idl.

Member Function Documentation

◆ CalculateKey()

HRESULT CanEasy::ICanEasyApplication::CalculateKey	(	[in] BSTR	dll,
		[in] long	secLevel,
		[in] BSTR	variant,
		[in] VARIANT	seed,
		[out, retval] VARIANT *
	)

Calls a security library to calculate a key for a passed seed (GenerateKeyEx)

Parameters

dll	Path to library
secLevel	Security level
variant	Variant
seed	Seed

Returns: Calculated key

◆ CalculateKeyOpt()

HRESULT CanEasy::ICanEasyApplication::CalculateKeyOpt	(	[in] BSTR	dll,
		[in] long	secLevel,
		[in] BSTR	variant,
		[in] BSTR	option,
		[in] VARIANT	seed,
		[out, retval] VARIANT *
	)

Calls a security library to calculate a key for a passed seed (GenerateKeyExOpt)

Parameters

dll	Path to dll library
secLevel	Security level
variant	Variant
option	Option
seed	Seed

Returns: Calculated key

◆ CreateCaptureTimer()

HRESULT CanEasy::ICanEasyApplication::CreateCaptureTimer ( [out, retval] ICaptureTimer ** pItem )

Creates a new capture timer

◆ CreateCompareTimer()

HRESULT CanEasy::ICanEasyApplication::CreateCompareTimer ( [out, retval] ICompareTimer ** pItem )

Creates a new compare timer

◆ CreateDatabaseItem()

HRESULT CanEasy::ICanEasyApplication::CreateDatabaseItem ( [out, retval] IDatabaseItemBase ** ppItem )

Creates a DatabaseItem object that can be attached to any database item.

◆ CreateObjectFilter()

HRESULT CanEasy::ICanEasyApplication::CreateObjectFilter ( [out, retval] IObjectFilter ** ppFilter )

Creates an object to filter/search database items

◆ CreatePreCopy()

HRESULT CanEasy::ICanEasyApplication::CreatePreCopy ( [out, retval] IPreCopy ** ppItem )

Creates an object to handle PreCopy events

◆ CreatePreTransmit()

HRESULT CanEasy::ICanEasyApplication::CreatePreTransmit ( [out, retval] IPreTransmit ** ppItem )

Creates an object to handle PreTransmit events

◆ CreateRxConfirm()

HRESULT CanEasy::ICanEasyApplication::CreateRxConfirm ( [out, retval] IRxConfirm ** ppItem )

Deprecated: Creates a new RxConfirm event.

Use TransmissionEvent instead

◆ CreateSelection()

HRESULT CanEasy::ICanEasyApplication::CreateSelection ( [out, retval] ISelection ** ppItem )

Creates a new selection which can contain database items

◆ CreateSerialPort()

HRESULT CanEasy::ICanEasyApplication::CreateSerialPort ( [out, retval] ISerialPort ** pVal )

Creates a serial port to read write data to a serial port

◆ CreateTimerControl()

HRESULT CanEasy::ICanEasyApplication::CreateTimerControl ( [out, retval] ITimerControl ** ppItem )

Creates a timer control

◆ CreateTxConfirm()

HRESULT CanEasy::ICanEasyApplication::CreateTxConfirm ( [out, retval] ITxConfirm ** ppItem )

Deprecated: Creates a new TxConfirm event.

Use TransmissionEvent instead

◆ CreateWorkspaceModule()

HRESULT CanEasy::ICanEasyApplication::CreateWorkspaceModule	(	[in] BSTR	sModuleName,
		[out, retval] IWorkspaceModule **
	)

Creates a workspace module.

Allows to read/write data into the CanEasy workspace

Parameters

sModuleName Unique name of the module section

Returns: Pointer to IWorkspaceModule

◆ DeInit()

HRESULT CanEasy::ICanEasyApplication::DeInit ( )

Deinitializes CanEasy.

Should be called just in case CanEasy is integrated into another process.

◆ Flash()

HRESULT CanEasy::ICanEasyApplication::Flash	(	[in] BSTR	sProps,
		[out, retval] long *
	)

Starts the flashing process for ISO-80126

Parameters

sProps Parameters passed to the flasher

Returns: Exit code of the flasher (0 means everything ok)

◆ GetAbsFilePath()

HRESULT CanEasy::ICanEasyApplication::GetAbsFilePath	(	[in] BSTR	sAbsPath,
		[in] BSTR	sRelPath,
		[out, retval] BSTR *
	)

Returns a path relative to an absolute path

Parameters

sAbsPath	Absolute path
sRelPath	Relative path

Returns: New path combining absolute and relative path

◆ Init()

HRESULT CanEasy::ICanEasyApplication::Init ( )

Initializes CanEasy.

Should be called just in case CanEasy is integrated into another process. It will initialize all plugins.

◆ IsExtendedId()

HRESULT CanEasy::ICanEasyApplication::IsExtendedId	(	[in] long	lMsgId,
		[out, retval] VARIANT_BOOL *
	)

Check whether the CAN identifier is extended

Parameters

lMsgId CAN identifier

Returns: True for extended identifier

◆ LoadWorkspace()

HRESULT CanEasy::ICanEasyApplication::LoadWorkspace ( [in] BSTR sFile )

Loads a workspace.

Should only be called if CanEasy is remote controlled Do not call this function from VBA, VSTA or MultiStudio context!

◆ MakeExtendedId()

HRESULT CanEasy::ICanEasyApplication::MakeExtendedId	(	[in] long	lMsgId,
		[out, retval] long *
	)

Sets the extended bit to a CAN identifier

Parameters

lMsgId CAN identifier

Returns: New CAN identifier with extended bit

◆ MakeReport()

HRESULT CanEasy::ICanEasyApplication::MakeReport	(	[in] BSTR	sReportText,
		[in] enum ReportType	enType
	)

Makes a report into the report window

Parameters

sReportText	Text to report
enType	Type of report (info, warning, error)

◆ MakeStandardId()

HRESULT CanEasy::ICanEasyApplication::MakeStandardId	(	[in] long	lMsgId,
		[out, retval] long *
	)

Removes the extended bit from a CAN identifier

Parameters

lMsgId CAN identifier

Returns: New CAN identifier without extended bit

◆ NewWorkspace()

HRESULT CanEasy::ICanEasyApplication::NewWorkspace ( )

Resets CanEasy.

Should only be called if CanEasy is remote controlled Do not call this function from VBA, VSTA or MultiStudio context!

◆ Quit()

HRESULT CanEasy::ICanEasyApplication::Quit ( )

Closes CanEasy.

Should only be called if CanEasy is remote controled Do not call this function from VBA, VSTA or MultiStudio context!

◆ ReadPort()

HRESULT CanEasy::ICanEasyApplication::ReadPort	(	[in] long	lAddr,
		[out, retval] long *	pVal
	)

Deprecated: Reads data from a port address.

This is not allowed any more on Windows 10

◆ ReadSetting()

HRESULT CanEasy::ICanEasyApplication::ReadSetting	(	[in] BSTR	sName,
		[in] VARIANT_BOOL	iniFile,
		[out, retval] BSTR *
	)

Reads a CanEasy setting by name

Parameters

sName	Name of the setting
iniFile	True to read setting from INI file

Returns: Read setting value

◆ RegisterExtension()

HRESULT CanEasy::ICanEasyApplication::RegisterExtension	(	[in] BSTR	sID,
		[in] IExtension *	iExtension
	)

Registers an extension.

Extension can add functions a global, bus, node, message and signal layer

Parameters

sID	Identifier of the extension
iExtension	Pointer the extension

◆ SaveWorkspace()

HRESULT CanEasy::ICanEasyApplication::SaveWorkspace ( [in] BSTR sFile )

Saves the workspace

Parameters

sFile Complete path of CSM file to save workspace

◆ ShowDisclaimer()

HRESULT CanEasy::ICanEasyApplication::ShowDisclaimer ( [out, retval] VARIANT_BOOL * pVal )

Shows the disclaimer window.

Should be called by applications that integrates CanEasy. If disclaimer is not accepted CanEasy is not allowed to be used.

Returns: True if disclaimer was accepted by the user

◆ Sleep()

HRESULT CanEasy::ICanEasyApplication::Sleep ( [in] long nPeriod )

Sleeps some time in milliseconds.

During the sleep events are still processed

◆ Start()

HRESULT CanEasy::ICanEasyApplication::Start ( )

Deprecated: Starts CanEasy.

Should be called just in case CanEasy in integrated into another process.

◆ StartSimulation()

HRESULT CanEasy::ICanEasyApplication::StartSimulation ( )

Starts the simulation.

Starting the simulation initializes the connected hardware adapter and starts sending receiving messages

◆ StopSimulation()

HRESULT CanEasy::ICanEasyApplication::StopSimulation ( )

Stops the simulation

◆ Transmit()

HRESULT CanEasy::ICanEasyApplication::Transmit ( [in] IDatabaseItem * pItem )

Transmits a database item

Parameters

pItem Database item to transmit (e.g. message, service)

◆ TransmitStringData()

HRESULT CanEasy::ICanEasyApplication::TransmitStringData	(	[in] BSTR	sRef,
		[in] BSTR	data,
		[out, retval] BSTR *
	)

Transmits a data by string ref

Parameters

sRef	Database string reference (path) to be used for transmission (e.g. diag-config for services)
data	String of byte array to be transmitted

Returns: Response or error text

◆ UnregisterExtension()

HRESULT CanEasy::ICanEasyApplication::UnregisterExtension ( [in] BSTR sID )

Unregisters an extension

Parameters

sID	Identifier of the extension

◆ WritePort()

HRESULT CanEasy::ICanEasyApplication::WritePort	(	[in] long	lAddr,
		[in] long	lVal
	)

Deprecated: Writes data to a port address.

This is not allowed any more on Windows 10

◆ WriteSetting()

HRESULT CanEasy::ICanEasyApplication::WriteSetting	(	[in] BSTR	sName,
		[in] VARIANT_BOOL	iniFile,
		[in] BSTR	sVal
	)

Changes a CanEasy setting by name

Parameters

sName	Name of the setting
iniFile	True to write setting into INI file
sVal	Value to set

Property Documentation

◆ Application

ICanEasyApplication CanEasy::ICanEasyApplication::Application

get

Return this application object

◆ AppWindow

IAppWindow CanEasy::ICanEasyApplication::AppWindow

get

Returns a pointer to the application window.

Can be used to show hide the CanEasy main window

◆ CanoePanels

ICANoePanelFactory CanEasy::ICanEasyApplication::CanoePanels

get

Return interface to the CANoe panels.

◆ CAPL

ICAPL CanEasy::ICanEasyApplication::CAPL

get

Returns a pointer the ICAPL interface.

Allows to compile CAN files

◆ Database

IDatabase CanEasy::ICanEasyApplication::Database

get

Returns the database of CanEasy

◆ Extension

IDispatch CanEasy::ICanEasyApplication::Extension([in] BSTR sID)

get

Returns global an extension

Parameters

sID	Identifier of the extension

Returns: Returns pointer to extension

◆ Hardware

IHardware CanEasy::ICanEasyApplication::Hardware

get

Returns a pointer the IHardware interface

◆ HardwareNames

VARIANT CanEasy::ICanEasyApplication::HardwareNames

get

Returns a string array available hardware names

◆ License

ILicense CanEasy::ICanEasyApplication::License

get

Returns pointer to license interface

◆ Record

IRecord CanEasy::ICanEasyApplication::Record

get

Returns to global record which allows to analyze the recording

◆ RecursivEvents

VARIANT_BOOL CanEasy::ICanEasyApplication::RecursivEvents

getset

Activates/Deactivates recursive events (active by default)

◆ Replay

IReplayCol CanEasy::ICanEasyApplication::Replay

get

Returns pointer to replay collection

◆ ReportWndCol

IReportWndCol CanEasy::ICanEasyApplication::ReportWndCol

get

Returns collection of all report windows

◆ ScreenUpdate

VARIANT_BOOL CanEasy::ICanEasyApplication::ScreenUpdate

getset

Activates/Deactivates all CanEasy windows

◆ Simulation

ISimulation CanEasy::ICanEasyApplication::Simulation

get

Returns the Simulation object.

It can be used to get events for simulation start/stop

◆ SimulationIsRunning

VARIANT_BOOL CanEasy::ICanEasyApplication::SimulationIsRunning

get

Returns True if simulation is running

◆ Tree

ICanEasyTree CanEasy::ICanEasyApplication::Tree

get

Returns pointer to CanEasy tree interface

◆ VarDatabase

IEnvVarDatabase CanEasy::ICanEasyApplication::VarDatabase

get

Deprecated: Returns the database to get access environment variables.

Use Database.GetObjectByStringRef to get variable references

◆ Vba

IDispatch CanEasy::ICanEasyApplication::Vba

get

Return interface to VBA

◆ VBACompatible

VARIANT_BOOL CanEasy::ICanEasyApplication::VBACompatible

getset

Converts data types to be compatible with VBA

◆ Version

BSTR CanEasy::ICanEasyApplication::Version

get

Returns current CanEasy version

◆ VirtualChannels

IVirtualChannelCol CanEasy::ICanEasyApplication::VirtualChannels

get

Returns a collection to all virtual channels.

VirtualChannel can be used to connect database channels with a hardware channel

◆ Workspace

BSTR CanEasy::ICanEasyApplication::Workspace

get

Returns the current file name of the workspace (csm file)

◆ WorkspacePath

BSTR CanEasy::ICanEasyApplication::WorkspacePath

get

Returns the current path of the workspace (csm file)