GetFile Method

Download a RemoteFile from the TFTP server.

Syntax

ANSI (Cross Platform)
int GetFile();

Unicode (Windows)
INT GetFile();
- (void)getFile;
#define MID_TFTP_GETFILE 4

IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_TFTP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string).

Example (Get a File)


TFTPControl.TFTPServer = "MyServer"
TFTPControl.LocalFile = "C:\filename.txt"
TFTPControl.RemoteFile = "/remotefile.txt"
TFTPControl.GetFile()

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 2020 C++ Edition - Version 20.0 [Build 8307]