Copyright © 2005-2018 MultiMedia Soft

Downloader.SessionStop method

Previous pageReturn to chapter overviewNext page

Remarks

 

Stops a download session previously started by a call to one between the Downloader.SessionStartToFile, Downloader.SessionStartToMemory and Downloader.SessionStartToPlayer methods.

 

A successful call to this method causes the CallbackForDownloaderEvents delegate to be invoked with the nEvent parameter set to EV_DOWNLOADER_SESSION_STOPPED.

 

For details about management of download sessions from HTTP and FTP servers, refer to the How to manage download sessions tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function SessionStop (

nDllSessionUniqueId as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes SessionStop (

Int32 nDllSessionUniqueId

);


 

[C++]

public: enumErrorCodes SessionStop (

Int32 nDllSessionUniqueId

);


 

 

Parameter

Description

 

 

nDllSessionUniqueId

The unique identifier of the download session generated by a previous call to one between the Downloader.SessionStartToFile, Downloader.SessionStartToMemory and Downloader.SessionStartToPlayer.methods.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details).

enumErrorCodes.NOERROR (0)

The method call was successful.