ResetQueue Method

Resets the queue of files to be transferred.

Syntax

ANSI (Cross Platform)
int ResetQueue();

Unicode (Windows)
INT ResetQueue();
- (void)resetQueue;
#define MID_SFTP_RESETQUEUE 19

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

Remarks

This method will remove all files from the transfer queue.

Calling this method will clear all files that were queued by QueueFile. Calling this method will not affect current transfers.

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]