FVSDK_FileInfo - FTP Voyager Software Development Kit

FVSDK_FileInfo - FVSDK_FileInfo.h
Next >>

The FVSDK_FileInfo is used by FVSDK_FindNextFile() to return the information about the current file being searched. The first call to FVSDK_FindNextFile() returns the information about the first file found in a directory. The return value identifies whether another file or directory exists. Subsequent calls retrieve information for the next file in the listing, with the return value always indicating whether more files exist.

Directory listings can be large. Therefore it is not recommended to maintain an array of these structures because this structure contains large strings for file names, permissions, etc. Instead, you should allocate the needed information in your own structures or objects.

Click on the member name to see additional information about the member. Click on the member type to view details about the type.

Structure & Members

typedef struct FVSDK_FileInfoStruct
{
// administrative variables
UINT	nSize;	// size, in bytes, of this structure
UINT	nVersion;	// version number of this structure; use the largest version number defined in FVSDK_FileInfo.h

// attributes defining the file or folder
char	pszFileName[FVSDK_MAX_FILE_NAME_SZ];	// the file name without the path
BOOL	bDirectory;	// TRUE if the item is a directory or folder

// misc. UNIX style information
BOOL	bSymbolicLink;	// TRUE if the item is a UNIX symbolic link (could be a file or directory)
char	pszPermissions[FVSDK_MAX_PERMS_SZ];	// if known, the file or directory permissions, usually in a UNIX style
char	pszUser[FVSDK_MAX_OWNER_SZ];	// if known, the UNIX owner (or user) name
char	pszGroup[FVSDK_MAX_GROUP_SZ];	// if known, the UNIX group
char	pszLinkedTo[FVSDK_MAX_LINKED_TO_SZ];	// if known, the file or folder to which the symbolic link is linked

// size
FVSDK_FILE_SIZE	fsFileSize;	// the size of the file in bytes
typedef ULONGLONG FVSDK_FILE_SIZE;
BOOL	bSizeSet;	// TRUE if the size element is set or known

// date and time
FVSDK_TIME	tmDateTime;	// the date and time of the file or folder. The tm_wday, tm_yday, and tm_idst elements are not used
typedef struct tm FVSDK_TIME;
BOOL	bDateSet;	// TRUE if the date is set (or known) as part of the date and time element
BOOL	bTimeSet;	// TRUE if the time is set (or known) as part of the date and time element

// misc.
char	pszType[FVSDK_MAX_TYPE_SZ];	// the file type for AS400 servers

} FVSDK_FileInfo;

Next >>

FVSDK_FileInfo - FVSDK_FileInfo.h

Structure & Members