NOTIFY_FILE_STATUS_STRUCT structure

---

Specifies information on a status of the file transfer while it occurs.

typedef struct _NOTIFY_FILE_STATUS_STRUCT
{
    char lpszTransferKey[UNIQUE_KEY_LENGTH + 1];
    BYTE iStatus;
    BYTE iStep;
    DWORD dwTotalSize;
    DWORD dwTransmittedSize;
    DWORD dwErrorCode;
} NOTIFY_FILE_STATUS_STRUCT;

Members

lpszTransferKey

Contains a unique transfer key to identify each file transfer in the application. For outgoing transfers this value is the same that returned in the TRANSFER_FILE_STRUCT structure after successful call of IServerClient::SendFileRequest method. For incoming transfers it is the same that the TRANSFER_NOTIFY_FILE_STRUCT structure contains sent via NOTIFY_NEW_TRANSFER notification.

iStatus

Specifies a current status of the file transfer. This member can be one of the following values:

FILE_TRANSFER_STATUS_ERROR

Error occurred during sending or receiving files. In this case the dwErrorCode member of the structure contains extended information on the error.

FILE_TRANSFER_STATUS_STARTED

File transfer is initiated and the files are about to be transmitted.

FILE_TRANSFER_STATUS_SENDING

The file data is being sending. In this status both the iStep and dwTransmittedSize members contain updated information on a current transfer progress and sent amount of data.

FILE_TRANSFER_STATUS_RECEIVING

The file data is being receiving. In this status both the iStep and dwTransmittedSize members contain updated information on a current transfer progress and received amount of data.

FILE_TRANSFER_STATUS_COMPLETED

The file data has been successfully transmitted.

iStep

A zero-based value of a current progress of the file transfer. The value increments from 0 to 10 and allows the application to display the progress in it's GUI.

dwTotalSize

The total size of the file data that is being transmitted.

dwTransmittedSize

A zero-based size of the data that has been transmitted. This value increments from 0 to the total size of the file data specified in the dwTotalSizemember.

dwErrorCode

This member that contains an extended code if iStatus is equal FILE_TRANSFER_STATUS_ERROR status code. For available codes see Available Extended Codes topic.