gpSkipFile
This function is used to skip transferring a certain file.
- GPResult gpSkipFile(
- GPConnection * connection,
- GPTransfer transfer,
- int index );
| Routine | Required Header | Distribution |
|---|---|---|
| gpSkipFile | <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] Index of the file within the GPTransfer object.
Remarks
This function is used to skip a file in the transfer. It can be called either before a file is transferred, or while a file is being transferred. If it is called before the file starts transferring, then the a GP_FILE_SKIP callback will be received when the file becomes the current file. If it is called while a file is being transferred, then the GP_FILE_SKIP will be called as soon as possible, and the file will stop transferring.
Section Reference: Gamespy Presence SDK