'Declaration
 
Public Function CreateSessionAsync( _
   ByVal applicationName As String, _
   ByVal destroyExistingSession As Boolean, _
   ByVal locale As String, _
   ByVal idleTimeoutMinutes As UInteger, _
   ByVal callback As ImGearIsisSessionCreated _
) As ImGearIsisOperationStatus

'Usage
 
Dim instance As ImGearIsisScannerService
Dim applicationName As String
Dim destroyExistingSession As Boolean
Dim locale As String
Dim idleTimeoutMinutes As UInteger
Dim callback As ImGearIsisSessionCreated
Dim value As ImGearIsisOperationStatus
 
value = instance.CreateSessionAsync(applicationName, destroyExistingSession, locale, idleTimeoutMinutes, callback)

public ImGearIsisOperationStatus CreateSessionAsync( 
   string applicationName,
   bool destroyExistingSession,
   string locale,
   uint idleTimeoutMinutes,
   ImGearIsisSessionCreated callback
)

public: ImGearIsisOperationStatus* CreateSessionAsync( 
   string* applicationName,
   bool destroyExistingSession,
   string* locale,
   uint idleTimeoutMinutes,
   ImGearIsisSessionCreated* callback
) 

public:
ImGearIsisOperationStatus^ CreateSessionAsync( 
   String^ applicationName,
   bool destroyExistingSession,
   String^ locale,
   uint idleTimeoutMinutes,
   ImGearIsisSessionCreated^ callback
) 

Parameters

applicationName

A string identifying the application that is using the toolkit. Some persistent settings are stored separately for each application, enabling the applications to behave independently of each other.

destroyExistingSession

Indicates if any existing session should be forcibly closed. Forcibly closing a session could result in loss of data. Because only one session can be open at a time, if a session is already open, then a value of false for this parameter results in an error. You can trap the error and take appropriate action. For example, you can inform your application user that another session is still open and must be closed first. If your application determines that the previous session should be forcibly closed, call the method again with this parameter set to true.

locale

The language in which to display user interface elements that are built into the toolkit. To use the system default locale, set this parameter to an empty string. A locale code is a language/region combination, with 2-letter codes for each separated by a hyphen. The default locale is en-US (US English), which is used if a UI does not exist for the requested locale.

idleTimeoutMinutes

The amount of time (in minutes) that the session is allowed to remain open with no ISIS Captiva Cloud service operation occurring. When the timeout has expired, the session closes automatically. The range of effective timeout values is 1–480, inclusive. If you specify anything higher than the maximum value, then the maximum value is used. If you specify 0, then a default value of 60 is used.

callback

Callback which is called when the session is created.

Return Value

Only one session can be open at a time. The restriction to a single session applies to all applications running on the same system. Only one application at a time can use ISIS Web Capture features.

Reference