Downloader.SessionStop method |
|
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 will fire the DownloaderSessionStopped event.
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. |