gpSetStatus
This function sets the local profile’s status.
- GPResult gpSetStatus(
- GPConnection * connection,
- GPEnum status,
- const gsi_char statusString[GP_STATUS_STRING_LEN],
- const gsi_char locationString[GP_LOCATION_STRING_LEN] );
| Routine | Required Header | Distribution |
|---|---|---|
| gpSetStatus | <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.
- status
- [in] An enum indicating the status to set.
- statusString
- [in] A text string with a user-readable explanation of the status.
- locationString
- [in] A URL indicating the local profile's location, in the form "gamename://IP.address:port/extra/info".
Remarks
This function sets the local profile’s status. The status consists of an enum specifying a mode (online, offline, playing, etc.), a text explanation of the status, and a URL specifying a location and protocol (e.g., "quake://12.34.56.78:9999").
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| gpSetStatus | gpSetStatusA | gpSetStatusW |
gpSetStatusW and gpSetStatusA are UNICODE and ANSI mapped versions of gpSetStatus. The arguments of gpSetStatusA are ANSI strings; those of gpSetStatusW are wide-character strings.
Section Reference: Gamespy Presence SDK