Difference between revisions of "Extensions.Flash.GetFlashSession"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''GetFlashSession'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetFlashSession | Specifies the handle of flash session by session ID | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash session related terms]] | [[UnsupportedFormatException]] | - }}
+
{{ClassificationActivity | GetFlashSession | Specifies the handle of flash session by session ID | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Flash session related terms]] | [[Extensions.Flash.UnsupportedFormatException|UnsupportedFormatException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
The '''GetFlashSession''' term is a handle of Flash session, identified by a session ID
 
The '''GetFlashSession''' term is a handle of Flash session, identified by a session ID
  
{{TermReturnValue| [[FlashSession]] | Handle of Flash Session.}}
+
{{TermReturnValue| [[Extensions.Flash.FlashSession|FlashSession]] | Handle of Flash Session.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| SessionID | [[String]] | [[Term]] | - | [1] | A unique identifier in the environment that is used to identify a Flash session.}}
+
{{TableRowPropertie1| SessionID | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | A unique identifier in the environment that is used to identify a Flash session.}}
 
|}
 
|}
  
Line 31: Line 31:
  
 
== See also ==
 
== See also ==
[[GetListOfValidFlashSessions]] <br/>
+
[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]] <br/>
[[GetSessionID]] <br/>
+
[[Extensions.Flash.GetSessionID|GetSessionID]] <br/>
[[GetSessionPriority]] <br/>
+
[[Extensions.Flash.GetSessionPriority|GetSessionPriority]] <br/>
[[GetNumberOfBlocks]] <br/>
+
[[Extensions.Flash.GetNumberOfBlocks|GetNumberOfBlocks]] <br/>
[[IsDownloadSession]] <br/>
+
[[Extensions.Flash.IsDownloadSession|IsDownloadSession]] <br/>
[[GetFlashKey]]
+
[[Extensions.Flash.GetFlashKey|GetFlashKey]]

Revision as of 07:34, 15 February 2016

Classification

Name GetFlashSession
Short Description Specifies the handle of flash session by session ID
Class Term
Extension OTX Flash extension
Group Flash session related terms
Exceptions UnsupportedFormatException
Checker Rules -
Standard Compliant Yes

OTL Syntax

FlashSessionTerm = Flash.GetFlashSession(StringTerm);

Description

The GetFlashSession term is a handle of Flash session, identified by a session ID

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
FlashSession Handle of Flash Session.

Properties

Name Data Type Class Default Cardinality Description
SessionID String Term - [1] A unique identifier in the environment that is used to identify a Flash session.

OTL Examples

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

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

See also

GetListOfValidFlashSessions
GetSessionID
GetSessionPriority
GetNumberOfBlocks
IsDownloadSession
GetFlashKey