Extensions.Flash.GetNumberOfSegments

From emotive
Revision as of 06:59, 15 February 2016 by Hb (talk | contribs) (Hb moved page GetNumberOfSegments to Extensions.Flash.GetNumberOfSegments: #3153)
Jump to navigation Jump to search

Classification

Name GetNumberOfSegments
Short Description Specifies the number of data segments in a block
Class Term
Extension OTX Flash extension
Group Flash block related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm = Flash.GetNumberOfSegments(FlashSessionTerm, IntegerTerm);

Description

The GetNumberOfSegments term specifies the number of data segments in a return block. If there are no segments, the return value is zero, otherwise a positive number will be.

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
Integer The number of data segments in a block.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] This element represents the FlashSession in which the block of interest resides.
Block Integer Term - [1] The number of the block from which the number of data segments to be accessed.

OTL Examples

DiagCom.ComChannel ComChannel1;
List<String> List1;
Flash.FlashSession FlashSession1;
Integer Integer1;

ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
FlashSession1 = Flash.GetFlashSession(List1[0]);
Integer1 = Flash.GetNumberOfSegments(FlashSession1, 1);

See also

GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
BlockIsValidForAudience