Extensions.Flash.GetLogicalBlockID
Jump to navigation
Jump to search
Contents
Classification
| Name | GetLogicalBlockID |
| Short Description | Gets the unique string identifying a block |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash block related terms |
| Exceptions | OutOfBoundsException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
StringTerm Flash.GetLogicalBlockID(FlashSessionTerm session, NumericTerm block);
Description
The GetLogicalBlockID term returns the unique String identifier of a block.
In ODX/MVCI based systems, the returned ID string will correspond to the SHORT-NAME of the block.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| String | The unique string identifying of a block. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Session | FlashSession | Term | - | [1] | This element represents the FlashSession in which the block resides. |
| Block | Numeric | Term | - | [1] | This element represents the block number. Float values will be truncated. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
String String1 = "";
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
String1 = Flash.GetLogicalBlockID(FlashSession1, 1);
See also
GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetCompressionEncryption
GetType
BlockIsValidForAudience
GetListOfValidFlashSessions
GetFlashSession
GetComChannel
