gpGetErrorString
This function gets the current error string for a connection.
- GPResult gpGetErrorString(
- GPConnection * connection,
- gsi_char errorString[GP_ERROR_STRING_LEN] );
| Routine | Required Header | Distribution |
|---|---|---|
| gpGetErrorString | <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.
- errorString
- [in] A text description of the current error.
Remarks
This function gets the current error string for connection. The error string is a text description of the most recent error that occurred on this connection. If no errors have occurred on this connection, the error string will be empty ("").
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| gpGetErrorString | gpGetErrorStringA | gpGetErrorStringW |
gpGetErrorStringW and gpGetErrorStringA are UNICODE and ANSI mapped versions of gpGetErrorString. The arguments of gpGetErrorStringA are ANSI strings; those of gpGetErrorStringW are wide-character strings.
Section Reference: Gamespy Presence SDK