Subsections of Functions

Functions (Alphabetical)

Functions (Alphabetical)

Total functions: 45

Function Owner Description
BindSimuatorCANPort([in] int index, [in] BSTR port_identifier, [in] VARIANT options) GemsDashDesign::IDashApplication Connect a physical CAN port to the simulator.
Cancel(void) GemsDashDesign::IDashJob Cancels the Job.
Click([in] VARIANT options) GemsDashDesign::IDashApplication Simulate a mouse click.
CloseWindow([in] VARIANT options, [out, retval] VARIANT *result) GemsDashDesign::IDashApplication Close a window (if possible).
ConfigureSimulator([in] VARIANT options) GemsDashDesign::IDashApplication Configure the next simulator launch without starting it.
CreateDeviceList([out, retval] IDashDeviceList **retval) GemsDashDesign::IDashApplication Gets a list of the devices that are attached to the system.
CreateOptionsMap([out, retval] IDashOptionsMap **options) GemsDashDesign::IDashApplication Create an instance of IDashOptionsMap that can be used to modify the behaviour of various functions that accept options.
DescriptionAt([in] int index, [out, retval] BSTR *retval) GemsDashDesign::IDashDeviceList Gets the description of the device at the given index.
DownloadSetup([in] BSTR filename, [in, optional] VARIANT options, [out, retval] IDashJob **retval) GemsDashDesign::IDashDevice Start a setup download for this device.
EmbedCdxModel([in] BSTR path) GemsDashDesign::IDashApplication Embed a CDX Model package into the currently open setup (if editable + supported).
EnumerateWindows([in, optional] VARIANT options, [out, retval] BSTR *result) GemsDashDesign::IDashApplication Enumerate Windows in the application.
EraseLog([in, optional] VARIANT options, [out, retval] IDashJob **retval) GemsDashDesign::IDashDevice Start an Erase Log operation for this device.
FocusWindow([in] VARIANT options) GemsDashDesign::IDashApplication Focus & raise a window (if possible).
GenerateHelpInfo([in, optional] VARIANT options, [out, retval] BSTR *result) GemsDashDesign::IDashApplication Generate Help Information as JSON.
Get([in] int index, [out, retval] IDashDevice **retval) GemsDashDesign::IDashDeviceList Gets a representation of the device at the given index.
GetProperties([in] VARIANT options, [out, retval] VARIANT *result) GemsDashDesign::IDashApplication Get all properties from a window / view.
GetProperty([in] VARIANT options, [in] BSTR name, [out, retval] VARIANT *result) GemsDashDesign::IDashApplication Get a single property from a window / view.
GetProperty([in] BSTR name, [out, retval] VARIANT *retval) GemsDashDesign::IDashOptionsMap
IdentifierAt([in] unsigned int index, [out, retval] BSTR *retval) GemsDashDesign::IDashCANPorts Get an identifier for the port at the specified index in the port list.
ImportCanDbc([in] BSTR path, [in] VARIANT options) GemsDashDesign::IDashApplication Import CAN DBC file.
InvokeAction([in] BSTR action_id, [in, optional] VARIANT options) GemsDashDesign::IDashApplication Invokes an action with the specified ID.
IsUsbAt([in] int index, [out, retval] VARIANT_BOOL *retval) GemsDashDesign::IDashDeviceList Tests whether the device uses a physical USB connection.
Keyboard([in] VARIANT options) GemsDashDesign::IDashApplication Simulate a keyboard.
ListCANPorts([out, retval] IDashCANPorts **retval) GemsDashDesign::IDashApplication Obtains an interface for listing CAN adaptors connected to the PC.
NameAt([in] unsigned int index, [out, retval] BSTR *retval) GemsDashDesign::IDashCANPorts Get friendly name of the port at the specified index in the port list.
NameAt([in] int index, [out, retval] BSTR *retval) GemsDashDesign::IDashDeviceList Gets the name of the device at the given index.
NewSetup([in] VARIANT options) GemsDashDesign::IDashApplication Creates a new setup.
OpenSetup([in] BSTR path, [in, optional] VARIANT options) GemsDashDesign::IDashApplication Opens the setup specified by ‘path’.
Refresh() GemsDashDesign::IDashCANPorts Refresh the ports list. Blocks execution until complete.
Refresh(void) GemsDashDesign::IDashDeviceList Rescan the system for the attached devices and update the list.
SaveSetup([in] VARIANT options) GemsDashDesign::IDashApplication Saves the current setup by its current file name.
SaveSetupAs([in] BSTR path, [in] VARIANT options) GemsDashDesign::IDashApplication Saves the current setup by a new file name.
SerialNumberAt([in] int index, [out, retval] BSTR *retval) GemsDashDesign::IDashDeviceList Gets the serial number of the device at the given index.
SetProperties([in] VARIANT options, [in] VARIANT props) GemsDashDesign::IDashApplication Set mutiple properties on a window / view.
SetProperty([in] VARIANT options, [in] BSTR name, [in] VARIANT value) GemsDashDesign::IDashApplication Set a single property on a window / view.
SetProperty([in] BSTR name, [in] VARIANT value) GemsDashDesign::IDashOptionsMap properties are made available by the IDispatch interface (late-binding).
SetSimulationChannel([in] BSTR channel, [in] VARIANT value) GemsDashDesign::IDashApplication Set a simulator channel value.
SupportsCdxModelImageDescriptor([in] LONG descriptorVersion, [out, retval] VARIANT_BOOL *supported) GemsDashDesign::IDashApplication Query implemented CDX Model image descriptor versions without loading a package.
TakeScreenShot([in, optional] VARIANT options, [out, retval] VARIANT *result) GemsDashDesign::IDashApplication Take a screenshot of a window or the whole application.
UploadFirmware([in] BSTR filename, [in, optional] VARIANT options, [out, retval] IDashJob **retval) GemsDashDesign::IDashDevice Start a firmware upload for this device.
UploadSetup([in] BSTR filename, [in, optional] VARIANT options, [out, retval] IDashJob **retval) GemsDashDesign::IDashDevice Start a setup upload for this device (programs opened setup into the device).
UploadSetupUnattended([in] BSTR filename, [in, optional] VARIANT options, [out, retval] IDashJob **retval) GemsDashDesign::IDashDevice Upload a setup without interactive prompts.
UsbPidAt([in] int index, [out, retval] int *retval) GemsDashDesign::IDashDeviceList Gets the USB PID (Product ID) of the device at the given index.
UsbVidAt([in] int index, [out, retval] int *retval) GemsDashDesign::IDashDeviceList Gets the USB VID (Vendor ID) of the device at the given index.
Wait(void) GemsDashDesign::IDashJob Wait for the Job to complete.

Functions by API

Total functions: 45

IDashApplication

Function Description
BindSimuatorCANPort([in] int index, [in] BSTR port_identifier, [in] VARIANT options) Connect a physical CAN port to the simulator.
Click([in] VARIANT options) Simulate a mouse click.
CloseWindow([in] VARIANT options, [out, retval] VARIANT *result) Close a window (if possible).
ConfigureSimulator([in] VARIANT options) Configure the next simulator launch without starting it.
CreateDeviceList([out, retval] IDashDeviceList **retval) Gets a list of the devices that are attached to the system.
CreateOptionsMap([out, retval] IDashOptionsMap **options) Create an instance of IDashOptionsMap that can be used to modify the behaviour of various functions that accept options.
EmbedCdxModel([in] BSTR path) Embed a CDX Model package into the currently open setup (if editable + supported).
EnumerateWindows([in, optional] VARIANT options, [out, retval] BSTR *result) Enumerate Windows in the application.
FocusWindow([in] VARIANT options) Focus & raise a window (if possible).
GenerateHelpInfo([in, optional] VARIANT options, [out, retval] BSTR *result) Generate Help Information as JSON.
GetProperties([in] VARIANT options, [out, retval] VARIANT *result) Get all properties from a window / view.
GetProperty([in] VARIANT options, [in] BSTR name, [out, retval] VARIANT *result) Get a single property from a window / view.
ImportCanDbc([in] BSTR path, [in] VARIANT options) Import CAN DBC file.
InvokeAction([in] BSTR action_id, [in, optional] VARIANT options) Invokes an action with the specified ID.
Keyboard([in] VARIANT options) Simulate a keyboard.
ListCANPorts([out, retval] IDashCANPorts **retval) Obtains an interface for listing CAN adaptors connected to the PC.
NewSetup([in] VARIANT options) Creates a new setup.
OpenSetup([in] BSTR path, [in, optional] VARIANT options) Opens the setup specified by ‘path’.
SaveSetup([in] VARIANT options) Saves the current setup by its current file name.
SaveSetupAs([in] BSTR path, [in] VARIANT options) Saves the current setup by a new file name.
SetProperties([in] VARIANT options, [in] VARIANT props) Set mutiple properties on a window / view.
SetProperty([in] VARIANT options, [in] BSTR name, [in] VARIANT value) Set a single property on a window / view.
SetSimulationChannel([in] BSTR channel, [in] VARIANT value) Set a simulator channel value.
SupportsCdxModelImageDescriptor([in] LONG descriptorVersion, [out, retval] VARIANT_BOOL *supported) Query implemented CDX Model image descriptor versions without loading a package.
TakeScreenShot([in, optional] VARIANT options, [out, retval] VARIANT *result) Take a screenshot of a window or the whole application.

IDashCANPorts

Function Description
IdentifierAt([in] unsigned int index, [out, retval] BSTR *retval) Get an identifier for the port at the specified index in the port list.
NameAt([in] unsigned int index, [out, retval] BSTR *retval) Get friendly name of the port at the specified index in the port list.
Refresh() Refresh the ports list. Blocks execution until complete.

IDashDevice

Function Description
DownloadSetup([in] BSTR filename, [in, optional] VARIANT options, [out, retval] IDashJob **retval) Start a setup download for this device.
EraseLog([in, optional] VARIANT options, [out, retval] IDashJob **retval) Start an Erase Log operation for this device.
UploadFirmware([in] BSTR filename, [in, optional] VARIANT options, [out, retval] IDashJob **retval) Start a firmware upload for this device.
UploadSetup([in] BSTR filename, [in, optional] VARIANT options, [out, retval] IDashJob **retval) Start a setup upload for this device (programs opened setup into the device).
UploadSetupUnattended([in] BSTR filename, [in, optional] VARIANT options, [out, retval] IDashJob **retval) Upload a setup without interactive prompts.

IDashDeviceList

Function Description
DescriptionAt([in] int index, [out, retval] BSTR *retval) Gets the description of the device at the given index.
Get([in] int index, [out, retval] IDashDevice **retval) Gets a representation of the device at the given index.
IsUsbAt([in] int index, [out, retval] VARIANT_BOOL *retval) Tests whether the device uses a physical USB connection.
NameAt([in] int index, [out, retval] BSTR *retval) Gets the name of the device at the given index.
Refresh(void) Rescan the system for the attached devices and update the list.
SerialNumberAt([in] int index, [out, retval] BSTR *retval) Gets the serial number of the device at the given index.
UsbPidAt([in] int index, [out, retval] int *retval) Gets the USB PID (Product ID) of the device at the given index.
UsbVidAt([in] int index, [out, retval] int *retval) Gets the USB VID (Vendor ID) of the device at the given index.

IDashJob

Function Description
Cancel(void) Cancels the Job.
Wait(void) Wait for the Job to complete.

IDashOptionsMap

Function Description
GetProperty([in] BSTR name, [out, retval] VARIANT *retval)
SetProperty([in] BSTR name, [in] VARIANT value) properties are made available by the IDispatch interface (late-binding).