<--libifp home

-=[  documentation  ]=-   libifp: ifp_transfer_status Struct Reference

ifp_transfer_status Struct Reference

---

Detailed Description

Statistics about a file transfer in progress.

The fields file_bytes, batch_bytes and is_batch are guaranteed to be valid. Fields not in use are set to 0 or NULL, so test before dereferrencing pointers or dividing numbers.

Data Fields
int	file_bytes
int	file_total
const char *	file_name
long	batch_bytes
long	batch_total
int	files_count
int	files_total
int	is_batch
void *	reserved1
void *	reserved2
void *	reserved3

---

Field Documentation

int ifp_transfer_status::file_bytes

the number of bytes transferred for the current file

int ifp_transfer_status::file_total

the expected number of bytes in the current file

const char* ifp_transfer_status::file_name

the name of the current file

long ifp_transfer_status::batch_bytes

The number of bytes transferred in the transfer so far

long ifp_transfer_status::batch_total

the total number of bytes expected during this transfer

int ifp_transfer_status::files_count

The number of files successfully transferred so far.

int ifp_transfer_status::files_total

The number of files expected to be transferred in this batch.

int ifp_transfer_status::is_batch

0 during single-file transfers, 1 during multi-file transfers

void* ifp_transfer_status::reserved1

reserved for internal use.

void* ifp_transfer_status::reserved2

reserved for internal use.

void* ifp_transfer_status::reserved3

reserved for internal use.

---

The documentation for this struct was generated from the following file:

• ifp.h

---