FVSDK_TransferStatus - FTP Voyager Software Development Kit

FVSDK_TransferStatus - FVSDK_TransferStatus.h
Next >>

The FVSDK_TransferStatus structure is passed to your application by the pfnNotifyTransferStatus callback function pointer in the FVSDK_Session structure. This structure identifies a unique transfer operation by the dwHandle variable. The nSize variable refers to the number of bytes allocated to the structure. This value is set by the FTP Voyager SDK.

The nVersion variable will always be FVSDK_TRANSFER_STATUS_CURRENT_VERSION.

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_TransferStatusStruct
{
// administrative variables
UINT	nSize;	// size, in bytes, of this structure (set by the FVSDK)
UINT	nVersion;	// version number of this structure; use the largest version number defined in FVSDK_TransferStatus.h. Should always be FVSDK_TRANSFER_STATUS_CURRENT_VERSION
DWORD	dwHandle;	// unique identifier

// information about the transfer session
BOOL	bDownload;	// TRUE when files are being downloaded, FALSE when being uploaded
BOOL	bMove;	// TRUE when files are being moved either up or down
BOOL	bMultiple;	// TRUE when more than one file is being transferred

// information about the current file(s)
char	pszFilePath[FVSDK_MAX_PATH];	// the file path
FVSDK_FILE_SIZE	fsFileSize;	// the file size, in bytes
typedef ULONGLONG FVSDK_FILE_SIZE;
FVSDK_FILE_SIZE	fsPos;	// the position in the file
typedef ULONGLONG FVSDK_FILE_SIZE;

// information about the multiple file transfer
FVSDK_FILE_SIZE	fsOverallSize;	// the total number of bytes to be transferred (all files)
typedef ULONGLONG FVSDK_FILE_SIZE;
FVSDK_FILE_SIZE	fsOverallPos;	// the current position within the total overall size (all files)
typedef ULONGLONG FVSDK_FILE_SIZE;

// multiple files
long	nFileNum;	// the file number being transferred
long	nTotalFiles;	// the total number of files to be transferred

// transfer rate
double	dBytesPerSecond;	// the total number of bytes per second being transferred

// estimated transfer completion
DWORD	dwRemainingHours;	// the estimated number of hours to completion
DWORD	dwRemainingMinutes;	// the estimated number of minutes to completion
DWORD	dwRemainingSeconds;	// the estimated number of seconds to completion

} FVSDK_TransferStatus;

Next >>

FVSDK_TransferStatus - FVSDK_TransferStatus.h

Structure & Members