gpGetTransferThrottle
This function can be used to get a transfer’s throttle setting.
NOTE: Throttling is not currently implemented. Throttle information is transmitted between the local profile and remote profile, but no throttling actually occurs.
- GPResult gpGetTransferThrottle(
- GPConnection * connection,
- GPTransfer transfer,
- int * throttle );
| Routine | Required Header | Distribution |
|---|---|---|
| gpGetTransferThrottle | <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.
- throttle
- [out] The throttle setting is stored here.
Remarks
NOTE: Throttling is not currently implemented.
This function is used to get the throttle setting for a transfer. If throttle is positive, it is the throttle setting in bytes-per-second. If zero, the transfer is paused. If –1, then there is no throttling.
Section Reference: Gamespy Presence SDK