Extensions.Flash.BlockIsValidForAudience

From emotive
Revision as of 07:55, 15 February 2016 by Hb (talk | contribs)
Jump to navigation Jump to search

Classification

Name BlockIsValidForAudience
Short Description Check if a block is valid for a given audience
Class Term
Extension OTX Flash extension
Group Flash block related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm = Flash.BlockIsValidForAudience(FlashSessionTerm, IntegerTerm, Audience);

Description

The BlockIsValidForAudience term return true if and only if a block is valid for a given audience.

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
Boolean Return true if a block is valid for a given audience.

Properties

Name Data Type Class Default Cardinality Description
Session FlashSession Term - [1] The Flash session in which the block is located.
Block Integer Term - [1] The block number.
Aucience Audience Value @Audience:SUPPLIER - This attribute defines which audience shall be used for the check.

OTL Examples

DiagCom.ComChannel ComChannel1;
List<String> List1;
Flash.FlashSession FlashSession1;
Boolean Boolean1 = false;

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

See also

GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType