CallbackForDownloaderEventsSet method |
|
Remarks
Sets the callback function which notifies about downloader events.
For further details about callback delegates see the How to synchronize the container application with the API tutorial.
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 CallbackForDownloaderEventsSet ( function as CallbackForDownloaderEvents ) as enumErrorCodes |
[C#] public enumErrorCodes CallbackForDownloaderEventsSet ( CallbackForDownloaderEvents function ); |
[C++] public: enumErrorCodes CallbackForDownloaderEventsSet ( CallbackForDownloaderEvents function ); |
Parameter |
Description |
|
|
function |
Callback function that will receive events generated by the downloader. Remember that callback functions must be as fast as possible in order to avoid slowing down overall performances. |
when using the API from Unmanaged C++ through COM interaction, where the client application is totally unaware about .NET delegates, you should use the "Ptr" version of the method which allows passing the pointer to the callback function:
[Unmanaged C++] enumErrorCodes CallbackForDownloaderEventsSetPtr ( (UINT_PTR) functionPointer ); |
Parameter |
Description |
|
|
functionPointer |
Pointer to the callback function. See the Adding the API to an unmanaged Visual C++ project tutorial for details about usage of the "Ptr" version of these 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. |