DWC_GetMatch*Value

Syntax

#include <dwc.h>

int DWC_GetMatchIntValue( int   index,
                          const char* keyString,
                          int   idefault );

const char* DWC_GetMatchStringValue( int   index,
                                     const char* keyString,
                                     const char* sdefault );

Description

This function returns the value that corresponds to the matchmaking condition key.
This function can only be used inside the player ranking callback. The values or character strings obtained are undefined if this function is called in other cases.

Because it takes time for added index keys to be applied by the server, a determination might be made that there is no index key, and the default value (default character string) might be returned, even if the index key is set on the application side.

Arguments

index Index of matchmaking candidate players. Be sure to pass the player evaluation callback's index argument as it is.
keyString Pointer to the character string that identifies the key.
idefault Default value if the player does not have the specified key.
sdefault The default character string when the player did not have the specified key.
Note: This default value is returned when the character string corresponding to the key is blank characters and during communciaions with the server.

Return Values

The character string that corresponds to the specified key held by the matchmaking candidate player. If the player does not have a key, the value passed to the idefault/sdefault argument is returned.

See Also

DWC_AddMatchKey*
DWCEvalPlayerCallback

Revision History

2008/04/28 Added that it takes time for the index key to be applied on the server.
2008/04/24 Added a description of how blank characters are handled by DWC_GetMatchStringValue.
2006/04/26 Integrated DWC_GetMatchIntValue and DWC_GetMatchStringValue.
2005/02/21 Corrected errors.
2005/07/22 Initial version.


CONFIDENTIAL