DirList Event

Fired when a directory entry is received.

Syntax

ANSI (Cross Platform)
virtual int FireDirList(SFTPDirListEventParams *e);
typedef struct {
const char *DirEntry;
const char *FileName;
int IsDir;
int64 FileSize;
const char *FileTime;
int IsSymlink; int reserved; } SFTPDirListEventParams; Unicode (Windows) virtual INT FireDirList(SFTPDirListEventParams *e);
typedef struct {
LPCWSTR DirEntry;
LPCWSTR FileName;
BOOL IsDir;
LONG64 FileSize;
LPCWSTR FileTime;
BOOL IsSymlink; INT reserved; } SFTPDirListEventParams;
- (void)onDirList:(NSString*)dirEntry :(NSString*)fileName :(BOOL)isDir :(long long)fileSize :(NSString*)fileTime :(BOOL)isSymlink;
#define EID_SFTP_DIRLIST 3

virtual INT IPWORKSSFTP_CALL FireDirList(LPSTR &lpszDirEntry, LPSTR &lpszFileName, BOOL &bIsDir, LONG64 &lFileSize, LPSTR &lpszFileTime, BOOL &bIsSymlink);

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectory method.

The format of the FileTime parameter returned by the class can be controlled through the FileTimeFormat configuration setting. If no format is specified, the class will format the date dependent on the year. If the filetime is in the same year, it will be formatted as "MMM dd HH:mm", otherwise it will be formatted as "MMM dd yyyy".

IsSymlink indicates whether the entry is a symbolic link. When the entry is a symbolic link the value of IsDir will always be False since this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or folder set RemoteFile and query the FileIsDir property.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8162]