gpSendBuddyRequest
This function sends a request to a remote profile to ask for permission to add the remote profile to the local profile’s buddy list.
- GPResult gpSendBuddyRequest(
- GPConnection * connection,
- GPProfile profile,
- const gsi_char reason[GP_REASON_LEN] );
| Routine | Required Header | Distribution |
|---|---|---|
| gpSendBuddyRequest | <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 remote profile to which the buddy request is being made.
- reason
- [in] A text string that (optionally) explains why the user is making the buddy request.
Remarks
This function sends a request to the given remote profile, asking if the local profile can make the remote profile a buddy. There is no immediate response to this message. If the remote profile authorizes the request, a buddy message and a status message will be received from the new buddy. However, this can take any amount of time.
This message causes the gpRecvBuddyRequest callback to be called for the remote profile.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| gpSendBuddyRequest | gpSendBuddyRequestA | gpSendBuddyRequestW |
gpSendBuddyRequestW and gpSendBuddyRequestA are UNICODE and ANSI mapped versions of gpSendBuddyRequest. The arguments of gpSendBuddyRequestA are ANSI strings; those of gpSendBuddyRequestW are wide-character strings.
Section Reference: Gamespy Presence SDK