GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Twelve — Internet Functions (continued)

FTPGetFirstFile Function

Overview

The FTPGetFirstFile function attempts to match the specified target pattern to the remote server’s file system and returns the first matching filename.

Syntax/Parameters

Syntax

string = FTPGetFirstFile ( handle hFTP, string target );

Parameters

hFTP

A handle to an FTP connection. Use the FTPOpenConnection function to open a connection.

target

A string containing a path ending in a filename or wildcard mask. The filename portion of name can include wildcard characters (for example, an asterisk (*) or a question mark (?)). The path should utilize forward slashes style path delimiters.

Return Value

A string containing the name of the first file found or empty for an error. Use the GetLastError function to retrieve further information.

Remarks

The FTP get first/next functions operate in the same manner and the GetFirstFile and GetNextFile functions and in fact the associated function to retrieve file properties can also be used. Do not use the GetName function since the underlying object is the FTP connection, not the enumeration.

For FTP, only a single enumeration can be performed at any one time for a connection (this is why there is not a separate enumeration handle. To reset the current enumeration, simply call FTPGetFirstFile again.

Related Functions

CloseHandle — Closes an object handle and releases any associated resources.

FTPGetNextFile — Gets the next file or folder name on a remote server.

GetFileAttributeBits — Gets file attributes as a bitwise set of flags from a specified handle or filename.

GetFileAttributeString — Gets file attributes in string form using a filename or handle for a file or an enumeration object.

GetFileCreateTime — Gets file creation time as a file time qword.

GetFileCreateTimeString — Gets file creation time as a string with optional date/time modes.

GetFileModifiedTime — Gets the file modified time as a file time qword.

GetFileModifiedTimeString — Gets file modified time as a string with optional date/time modes.

GetFileSize — Gets the size of a file from a file handle, file enumeration handle, folder, or FTP object.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.