gpSetInfos
These functions are used to set local info.
- GPResult gpSetInfos(
- GPConnection * connection,
- GPEnum info,
- const gsi_char * value );
| Routine | Required Header | Distribution |
|---|---|---|
| gpSetInfos | <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.
- info
- [in] An enum indicating what info to update.
- value
- [in] The string value.
Remarks
These functions are used to set local info. The info does not actually get updated (sent to the server) until the next call to gpProcess.
If a string is longer than the allowable length for that info, it will be truncated without warning.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| gpSetInfos | gpSetInfosA | gpSetInfosW |
gpSetInfosW and gpSetInfosA are UNICODE and ANSI mapped versions of gpSetInfos. The arguments of gpSetInfosA are ANSI strings; those of gpSetInfosW are wide-character strings.
Section Reference: Gamespy Presence SDK