LabWindows/CVI

Table of Contents
  • LabWindows/CVI Fundamentals
  • Creating Applications
  • Distributing Applications
  • Library Reference
  • Programmer Reference
  • Hardware Information

InetFTPRetrieveFile

int InetFTPRetrieveFile (int FTPHandle, const char *localFile, const char *remoteFile, int transferType);

Purpose

Receives a file over an open FTP connection.

Parameters

Input
Name Type Description
FTPHandle int A handle returned by the InetFTPLogin or InetFTPLoginEx function. The handle identifies an active FTP connection.
localFile const char * The pathname of the destination file on the local machine. The path can be absolute or relative to the current working directory.

If the file exists, it is overwritten.
remoteFile const char * The pathname of the remote file to retrieve. The path can be absolute or relative to the current working directory on the remote machine.
transferType int The mode in which the file is to be transferred. The following modes are valid:

INET_FTP_FILE_TYPE_ASCII

The file is converted into the remote machine's ASCII file format (with regard to newlines and carriage returns).

INET_FTP_FILE_TYPE_BINARY

The file is transferred exactly as is.

Return Value

Name Type Description
result int Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Additional Information

Library: Internet Library

Include file: cvintwrk.h

LabWindows/CVI compatibility: LabWindows/CVI 7.1 and later

Example

Refer to internet\ftpclnt\ftpclnt.cws for an example of using the InetFTPRetrieveFile function.

Log in to get a better experience