DWC_GetMatch*Value

C Specification

#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 or character string that corresponds to the matchmaking index key.
This function is guaranteed only for use inside the player evaluation callback. The returned value is undefined if the function is called from outside of the callback.

Arguments

index Index of matchmaking candidate players. Be sure to pass the player evaluation callback's index argument as is.
keyString Pointer to (the character string for key identification) the key name.
idefault The default value if the player does not have the specified key.
sdefault The default character string if the player does not have the specified key.

Return Values

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

See Also

DWC_AddMatchKey*, DWCEvalPlayerCallback

Revision History

04/26/2006 Unified DWC_GetMatchIntValue/DWC_GetMatchStringValue
02/21/2005 Corrected writing errors
07/22/2005 Initial version