IPWorks SSH 2020 macOS Edition

Questions / Feedback?

RenameFileComplete Event

Fired when a RenameFile operation completes (or fails).

Syntax

func onRenameFileComplete(operationId: String, errorCode: Int32, errorDescription: String, remoteFile: String, remotePath: String, newFileName: String)

Remarks

This event fires when a RenameFile operation completes either successfully or unsuccessfully. If the operation succeeded ErrorCode will be 0. If the operation failed or was canceled by CancelOperation ErrorCode will contain a non-zero value and ErrorDescription will contain a description of the error. Please refer to the Error Codes section for possible error codes.

OperationId is the Id of the completed operation. This value will match the Operation Id returned by the method which initiated the operation.

ErrorCode holds the error code (if any). A value of 0 indicates success. A positive value indicates failure.

ErrorDescription is a description of the error.

RemoteFile is the remote file that was specified when the operation was initiated.

RemotePath is the remote path that was specified when the operation was initiated.

NewFileName is the name to which the file was renamed as provided when RenameFile was originally called.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 macOS Edition - Version 20.0 [Build 8501]