gpGetFileProgress
This function is used to get the progress of a file being transferred.
- GPResult gpGetFileProgress(
- GPConnection * connection,
- GPTransfer transfer,
- int index,
- int * progress );
| Routine | Required Header | Distribution |
|---|---|---|
| gpGetFileProgress | <gp.h> | SDKZIP |
Return Value
This function returns GP_NO_ERROR upon success. Otherwise a valid GPResult is returned.
Parameters
- connection
- [in] A GP connection interface.
- transfer
- [in] A pointer to a GPTransfer object.
- index
- [in] The index of the file within the GPTransfer object.
- progress
- [in] The transfer progress.
Remarks
This function is used to get the progress of a file being transferred, or in other words, the number of bytes of the file either sent or received so far. If the file hasn’t started transferring yet, the progress will be 0. The progress will be continually updated while the file is being transferred. If the file finishes transferring successfully, the progress should be the same as the file’s size.
Section Reference: Gamespy Presence SDK