DWC_RnkResGetRow

Syntax

#include <dwc.h>
DWCRnkError DWC_RnkResGetRow(DWCRnkData *out,
                             u32 index);

Arguments

out Pointer to the DWCRnkData structure that gets the data.
index The index of the data to get.

Return Values

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

Description

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

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

A ranking is stored in the order field only for the row that holds the local host's own score. An exception to this rule occurs in top ranking list retrieval mode, where 0 is stored in the local host's own score row as well as in the other rows.

Revision History

5.1 PR2
Added a description of conditions under which the ranking is stored in the order field.

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL