SetDownloadStream Method

Sets the stream to which the downloaded data from the server will be written.

Syntax

ANSI (Cross Platform)
int SetDownloadStream(IPWorksSFTPStream* sDownloadStream);

Unicode (Windows)
INT SetDownloadStream(IPWorksSFTPStream* sDownloadStream);
#define MID_SFTP_SETDOWNLOADSTREAM 20

IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

If a download stream is set before the Download method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

The class will automatically close this stream if CloseStreamAfterTransfer is true (default). If the stream is closed, you will need to call SetDownloadStream again before calling Download again.

The downloaded content will be written starting at the current position in the stream.

Note: SetDownloadStream and LocalFile will reset the other.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8162]