Difference between revisions of "Extensions.Flash.GetDownloadData"
Jump to navigation
Jump to search
m (Hb moved page GetDownloadData to Extensions.Flash.GetDownloadData: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:Flash]] | + | {{DISPLAYTITLE: '''GetDownloadData'''}}[[Category:Flash]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetDownloadData | Fills a [[ByteField]] variable with data about the context of a session from Flash | [[Action]]| [[Flash|OTX Flash extension]] | [[Flash related actions]] | [[OutOfBoundsException]] | - }} | + | {{ClassificationActivity | GetDownloadData | Fills a [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] variable with data about the context of a session from Flash | [[Action]]| [[Extensions.Flash|OTX Flash extension]] | [[Flash related actions]] | [[OutOfBoundsException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 14: | Line 14: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Session | [[FlashSession]] | [[Term]] | - | [1] | Flash session which provides data which are addressed.}} | + | {{TableRowPropertie1| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | Flash session which provides data which are addressed.}} |
| − | {{TableRowPropertie2| Block | [[Integer]] | [[Term]] | - | [1] | By this element, a block in the context of Flash session is considered. This value should be in the range of the existing blocks.}} | + | {{TableRowPropertie2| Block | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | By this element, a block in the context of Flash session is considered. This value should be in the range of the existing blocks.}} |
| − | {{TableRowPropertie1| Segment | [[Integer]] | [[Term]] | - | [1] | By this element, a segment in the context of Flash session is considered. This value should be in the range of existing segments.}} | + | {{TableRowPropertie1| Segment | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | By this element, a segment in the context of Flash session is considered. This value should be in the range of existing segments.}} |
| − | {{TableRowPropertie2| Size | [[Integer]] | [[Term]] | - | [1] | This element defines how much bytes of data from the context to be read. It should be a positive value.}} | + | {{TableRowPropertie2| Size | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | This element defines how much bytes of data from the context to be read. It should be a positive value.}} |
| − | {{TableRowPropertie1| Position | [[Integer]] | [[Term]] | - | [1] | This element defines the first position, to be read by the activity. Position must be greater than or equal to zero and not greater than the size of the segment minus one.}} | + | {{TableRowPropertie1| Position | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | This element defines the first position, to be read by the activity. Position must be greater than or equal to zero and not greater than the size of the segment minus one.}} |
| − | {{TableRowPropertie2| Data | [[ByteField]] | [[Variable]] | - | [1] | This item sets the variable into which the read data should be stored.}} | + | {{TableRowPropertie2| Data | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Variable]] | - | [1] | This item sets the variable into which the read data should be stored.}} |
|} | |} | ||
| Line 36: | Line 36: | ||
== See also == | == See also == | ||
| − | [[StoreUploadData]] <br/> | + | [[Extensions.Flash.StoreUploadData|StoreUploadData]] <br/> |
| − | [[SetFlashSession]] | + | [[Extensions.Flash.SetFlashSession|SetFlashSession]] |
Revision as of 07:11, 15 February 2016
Classification
| Name | GetDownloadData |
| Short Description | Fills a ByteField variable with data about the context of a session from Flash |
| Class | Action |
| Extension | OTX Flash extension |
| Group | Flash related actions |
| Exceptions | OutOfBoundsException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
Flash.GetDownloadData(FlashSession, NumericTerm, NumericTerm, NumericTerm, NumericTerm, ByteFieldVariable);Description
GetDownloadData fills a given otx:ByteField variable with data about the context of a session from Flash.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Session | FlashSession | Term | - | [1] | Flash session which provides data which are addressed. |
| Block | Integer | Term | - | [1] | By this element, a block in the context of Flash session is considered. This value should be in the range of the existing blocks. |
| Segment | Integer | Term | - | [1] | By this element, a segment in the context of Flash session is considered. This value should be in the range of existing segments. |
| Size | Integer | Term | - | [1] | This element defines how much bytes of data from the context to be read. It should be a positive value. |
| Position | Integer | Term | - | [1] | This element defines the first position, to be read by the activity. Position must be greater than or equal to zero and not greater than the size of the segment minus one. |
| Data | ByteField | Variable | - | [1] | This item sets the variable into which the read data should be stored. |
OTL Examples
DiagCom.ComChannel ComChannel1;
List<String> List1;
ByteField Data1;
Flash.FlashSession FlashSession1;
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
FlashSession1 = Flash.GetFlashSession(List1[0]);
Flash.GetDownloadData(FlashSession1, 0, 0, 1, 0, Data1);