Inherits IDispatch.

Detailed Description

The CAPL interface gives access to the CAPL converter.

You can configure the CAPL converter and start the compilation.

 
    interface ICAPL : IDispatch
    {
        HRESULT Compile([in] VARIANT_BOOL boOverwrite, [out, retval] VARIANT_BOOL*);
        HRESULT AddCANFile([in] BSTR file);
        HRESULT RemoveCANFile([in] BSTR file);
        HRESULT ActivateCANFile([in] BSTR file);
        HRESULT DeactivateCANFile([in] BSTR file);
        HRESULT AddDll([in] BSTR file);
        HRESULT RemoveDll([in] BSTR file);
        HRESULT SetOutPath([in] BSTR sPath);
        HRESULT SetExtendedErrOutput([in] VARIANT_BOOL boActive);
        HRESULT AddChannel([in] BSTR file, [in] BSTR channel);
        HRESULT RemoveChannel([in] BSTR file, [in] BSTR channel);
        HRESULT SetNodeName([in] BSTR file, [in] BSTR name);
        HRESULT SetConfigFile([in] BSTR file);
        HRESULT RunTest([in] BSTR project, [out, retval] VARIANT_BOOL*);
    };
 

Definition at line 7515 of file cand_tlb.idl.

Member Function Documentation

◆ ActivateCANFile()

HRESULT CanEasy::ICAPL::ActivateCANFile ( [in] BSTR file )

Activates a CAN file.

Just activated CAN files are compiled

◆ AddCANFile()

HRESULT CanEasy::ICAPL::AddCANFile ( [in] BSTR file )

Adds a new CAN file for compilation

◆ AddChannel()

HRESULT CanEasy::ICAPL::AddChannel	(	[in] BSTR	file,
		[in] BSTR	channel
	)

Adds a channel to a CAN file

Parameters

file	CAN file
channel	Name of database channel to assign

◆ AddDll()

HRESULT CanEasy::ICAPL::AddDll ( [in] BSTR file )

Adds a CAPL dll

◆ Compile()

HRESULT CanEasy::ICAPL::Compile	(	[in] VARIANT_BOOL	boOverwrite,
		[out, retval] VARIANT_BOOL *
	)

Starts compilation of all CAPL files

Parameters

boOverwrite True to overwrite already compiled nodes. False will just load already converted nodes.

Returns: True if compilation succeeded

◆ DeactivateCANFile()

HRESULT CanEasy::ICAPL::DeactivateCANFile ( [in] BSTR file )

Deactivates a CAN file.

Just activated CAN files are compiled

◆ RemoveCANFile()

HRESULT CanEasy::ICAPL::RemoveCANFile ( [in] BSTR file )

Removes a CAN file

◆ RemoveChannel()

HRESULT CanEasy::ICAPL::RemoveChannel	(	[in] BSTR	file,
		[in] BSTR	channel
	)

Removes a channel from a CAN file

Parameters

file	CAN file
channel	Name of database channel to remove

◆ RemoveDll()

HRESULT CanEasy::ICAPL::RemoveDll ( [in] BSTR file )

Removes a CAPL dll

◆ RunTest()

HRESULT CanEasy::ICAPL::RunTest	(	[in] BSTR	project,
		[out, retval] VARIANT_BOOL *
	)

Runs the tests of a project.

The CAN file must export MainTest function.

Parameters

project Name of the project to start tests

Returns: True if test succeeded

◆ SetConfigFile()

HRESULT CanEasy::ICAPL::SetConfigFile ( [in] BSTR file )

Sets the CFG file

Parameters

file CFG

◆ SetExtendedErrOutput()

HRESULT CanEasy::ICAPL::SetExtendedErrOutput ( [in] VARIANT_BOOL boActive )

Activates/Deactivates extended error info.

Extended errors allow to detect file and line of error

◆ SetNodeName()

HRESULT CanEasy::ICAPL::SetNodeName	(	[in] BSTR	file,
		[in] BSTR	name
	)

Set the node/ECU name of a CAN file

Parameters

file	CAN file
name	Node name

◆ SetOutPath()

HRESULT CanEasy::ICAPL::SetOutPath ( [in] BSTR sPath )

Sets the output path.

If path is empty (default) the compiled CAP files are placed in the same folder like the CAN files If path is set all CAPL files are placed in that folder

Parameters

sPath Path to folder to output compiled CAP files