scReportAddStringValue
Adds a string value to the report for a specific key.
- SCResult scReportAddStringValue(
- SCReportPtr theReportData,
- gsi_u16 theKeyId,
- const gsi_char * theValue );
| Routine | Required Header | Distribution |
|---|---|---|
| scReportAddStringValue | <sc.h> | SDKZIP |
Return Value
Enum value used to indicate the specific result of the request. This will return SCResult_NO_ERROR if the request completed successfully.
Parameters
- theReportData
- [in] A valid SC Report object
- theKeyId
- [in] The string key's indentifer
- theValue
- [in] The string value
Remarks
The host or player can call this function to add either global, player-, or team-specific data. A report needs to be created before calling this function. For global keys, this function can only be called after starting global data. For player or teams, a new player or team needs to be added.