CanEasy COM-Help
CanEasy::IHardwareConfiguration Interface Reference

Inherits IDispatch.

Detailed Description

The hardware configuration contains devices.

Just one hardware configuration can be active The active configuration is used to detected the adapters to be used Use CanEasyApplication.SelectHardware for a more easy hardware setup.

interface IHardwareConfiguration : IDispatch
{
HRESULT Name([out, retval] BSTR *sName);
HRESULT Name([in] BSTR sName);
HRESULT Active([out, retval] VARIANT_BOOL *pActive);
HRESULT Active([in] VARIANT_BOOL boActive);
HRESULT ActiveForWorkspace([out, retval] VARIANT_BOOL *pActive);
HRESULT ActiveForWorkspace([in] VARIANT_BOOL boActive);
HRESULT Delete();
HRESULT AddDevice([in] BSTR sVendor, [in] BSTR sDevice, [in] BSTR sDeviceId, [out, retval] IDevice**);
HRESULT DeleteDevice([in] BSTR sVendor, [in] BSTR sDevice, [in] BSTR sDeviceId);
HRESULT Export([in] BSTR sFile);
HRESULT Devices([out, retval] IDeviceCol**);
};

Definition at line 8885 of file cand_tlb.idl.

Member Function Documentation

◆ AddDevice()

HRESULT CanEasy::IHardwareConfiguration::AddDevice ( [in] BSTR  sVendor,
[in] BSTR  sDevice,
[in] BSTR  sDeviceId,
[out, retval] IDevice **   
)

Adds a new device to this configuration

Parameters
sVendorName of the vendor
sDeviceName of the device
sDeviceIdDevice identifier (can be serial number or device id)
Returns
Pointer to new added device

◆ Delete()

HRESULT CanEasy::IHardwareConfiguration::Delete ( )

Deletes this configuration

◆ DeleteDevice()

HRESULT CanEasy::IHardwareConfiguration::DeleteDevice ( [in] BSTR  sVendor,
[in] BSTR  sDevice,
[in] BSTR  sDeviceId 
)

Deletes a device from this configuration

Parameters
sVendorName of the vendor
sDeviceName of the device
sDeviceIdDevice identifier (can be serial number or device id)

◆ Export()

HRESULT CanEasy::IHardwareConfiguration::Export ( [in] BSTR  sFile)

Exports the configuration setup to an xml file

Parameters
sFileFile to export

Property Documentation

◆ Active

VARIANT_BOOL CanEasy::IHardwareConfiguration::Active
getset

True if the configuration is active.

Just one hardware configuration can be active

◆ ActiveForWorkspace

VARIANT_BOOL CanEasy::IHardwareConfiguration::ActiveForWorkspace
getset

Automatic activation of this configuration when workspace is loaded

◆ Devices

IDeviceCol CanEasy::IHardwareConfiguration::Devices
get

Returns a collection with devices contained by the configuration

◆ Name

BSTR CanEasy::IHardwareConfiguration::Name
getset

Name of the configuration

CanEasy::IHardwareConfiguration::ActiveForWorkspace
VARIANT_BOOL ActiveForWorkspace
CanEasy::IHardwareConfiguration::Delete
HRESULT Delete()
CanEasy::IHardwareConfiguration::Devices
IDeviceCol Devices
CanEasy::IHardwareConfiguration::Active
VARIANT_BOOL Active
True if the configuration is active.
CanEasy::IHardwareConfiguration::Name
BSTR Name
CanEasy::IHardwareConfiguration::AddDevice
HRESULT AddDevice([in] BSTR sVendor, [in] BSTR sDevice, [in] BSTR sDeviceId, [out, retval] IDevice **)
CanEasy::IHardwareConfiguration::DeleteDevice
HRESULT DeleteDevice([in] BSTR sVendor, [in] BSTR sDevice, [in] BSTR sDeviceId)
CanEasy::IHardwareConfiguration::Export
HRESULT Export([in] BSTR sFile)