Extensions.Flash.CreateFlashJobByName

From emotive
Revision as of 03:14, 1 August 2014 by Nb (talk | contribs) (→‎Properties)
Jump to navigation Jump to search

Classification

Name CreateFlashJobByName
Short Description Create a new FlashJob for the specified ComChannel
Class Term
Extension OTX Flash extension
Group Flash jobs related terms
Exceptions UnknownTargetException
Checker Rules -
Standard Compliant Yes

Pseudo-Code Syntax

FlashJob CreateFlashJobByName(ComChannel myComChannel, String name);

Description

The CreateFlashJobByName term create a new FlashJob for the specified ComChannel. The FlashJob can subsequently be used for initiating an ECU reprogramming session.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
FlashJob A new FlashJob for the specified ComChannel.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] Communication Channel.
Name String Term - [1] Represents the name of the to-be-created FlashJob.
Session FlashSession Term - [0..1] This optional element represents the FlashSession to be programmed by the FlashJob.

Examples

ComChannel myComCannel = GetComChannel("LL_AirbaUDS", "", false);
FlashJob result = CreateFlashJobByName(myComCannel, "flashJobName");

See also

CreateFlashJob
CreateFlashJobBySemantic
GetComChannel