DWC_GetMatchStringValue

Syntax

#include <dwc.h>
const char* DWC_GetMatchStringValue(int index,
                                    const char *keyString,
                                    const char *sdefault);

Arguments

index Index of the matchmaking candidate player. This passes the index argument of the evaluation callback, unchanged.
keyString Pointer to the string for identifying the key.
sdefault The default character string for players who do not have a specified key.
Note: This default value is also returned if an empty string corresponds to the key or if communications with the server are under way.

Return Values

The string corresponding to the specified key held by the matchmaking candidate player. If they have no key, the string passed to the sdefault argument is returned.

Description

Returns a text string that corresponds to the matchmaking condition 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 the callback.

The default value is returned if an empty string ("") was specified with the DWC_AddMatchKeyString function or if the requested value has not yet been returned by the server.

It takes some time for the addition of a condition key to be propagated to the server. Thus, even if the application sets the condition key, it is sometimes determined to not exist, and the default value is returned.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL