Difference between revisions of "Extensions.Flash.GetNumberOfBlocks"
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetNumberOfBlocks''' term | + | The '''GetNumberOfBlocks''' term will return the number of blocks in a '''FlashSession'''. If no blocks exist, the return value will be zero, otherwise it will be a positive number. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of blocks in a flash session.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | The number of blocks in a flash session.}} | ||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' from which the number of blocks | + | {{TableRowPropertie2| Session | [[Extensions.Flash.FlashSession|FlashSession]] | [[Term]] | - | [1] | This element represents the '''FlashSession''' from which the number of blocks will be returned.}} |
|} | |} | ||
Latest revision as of 01:49, 13 September 2019
Contents
Classification
| Name | GetNumberOfBlocks |
| Short Description | Gets the number of blocks in a FlashSession |
| Class | Term |
| Extension | OTX Flash extension |
| Group | Flash session related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
IntegerTerm Flash.GetNumberOfBlocks(FlashSessionTerm session);Description
The GetNumberOfBlocks term will return the number of blocks in a FlashSession. If no blocks exist, the return value will be zero, otherwise it will be a positive number.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Integer | The number of blocks in a flash session. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Session | FlashSession | Term | - | [1] | This element represents the FlashSession from which the number of blocks will be returned. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
Integer Integer1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
Integer1 = Flash.GetNumberOfBlocks(FlashSession1);See also
GetListOfValidFlashSessions
GetFlashSession
GetSessionID
GetFlashKey
GetSessionPriority
IsDownloadSession
GetComChannel
