DWC_RnkResGetRow

Syntax

#include <dwc.h>

DWCRnkError DWC_RnkResGetRow(DWCRnkData *out,
                             u32 index);

Arguments

out Pointer to the DWCRnkData structure to retrieve data from.
index The index being obtained.

Return Values

DWC_RNK_SUCCESS Succeeded.
DWC_RNK_IN_ERROR An error is occurring.
DWC_RNK_ERROR_INVALID_MODE Invalid mode.
DWC_RNK_ERROR_INVALID_PARAMETER Invalid parameter.
DWC_RNK_ERROR_NOTCOMPLETED Communications not completed.
DWC_RNK_ERROR_EMPTY_RESPONSE Empty response.

Description

Extracts and gets an arbitrary row from the ranking list obtained via communications.

The buffer for the obtained data is released either when the DWC_RnkShutdown function is called or when the next asynchronous process starts. Save a backup as necessary.

A ranking will be stored in the order field of the row which holds the local player's own score. However, an exception to this occurs in top ranking list retrieval mode: in this mode 0 is stored in the local player's own score row, as well as in the other rows.

Revision History

1.1.2
Added an explanation of the conditions in which ranking is stored to the order field.

CONFIDENTIAL