Important: The information in this document is obsolete and should not be used for new development.
DownloadCyberItem
Requests the download of data referenced by a Cyberdog item to disk.
CDDownloadRequestID DownloadCyberItem (in CyberItem item, in FSSpecPtr spec);
item- The
CyberItemobject that specifies the data to be downloaded to disk.spec- A pointer to a file specification that specifies the file in which to save the data.
- return value
- An ID that uniquely identifies the download request.
DISCUSSION
This method adds a Cyberdog item to this download part's queue. Ifnilis specified for thespecparameter, the download part decides where to save the data. To cancel a download request, you call theCancelRequestmethod, passing the ID returned by this method.If you wish to receive notification when a download is complete, you should request the download by calling
PostDownloadRequestinstead of this method.If you subclass
CyberDownloadExtension, you must override this method. Your override must not call its inherited method; that is, your override method must implement this method's functionality completely.SEE ALSO
TheCancelRequestmethod (page 214).
ThePostDownloadRequestmethod (page 215).