gpAddToBlockedList
Adds a remote profile to the local player's blocked list.
- GPResult gpAddToBlockedList(
- GPConnection * connection,
- GPProfile profile );
| Routine | Required Header | Distribution |
|---|---|---|
| gpAddToBlockedList | <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.
- profile
- [in] The profileid of the player to be blocked.
Remarks
A blocked player is essentially invisible to player who has him/her blocked. The local player will not receive any communication from the blocked player, nor will the local player be able to contact the blocked player in any way.
This function will only work when GP is connected. This function will not return any callback upon success, but the GP_ERROR callback will be called should an error occur during the add attempt.
Section Reference: Gamespy Presence SDK
See Also: gpRemoveFromBlockedList, gpGetNumBlocked, gpGetBlockedProfile, gpIsBlocked