DWC_RnkPutScoreAsync

Syntax

#include <dwc.h>
DWCRnkError DWC_RnkPutScoreAsync(u32 category,
                                 DWCRnkRegion region,
                                 s32 score,
                                 void *data,
                                 u32 size);

Arguments

category Category ID for identifying rankings (category ID is a numeric value ranging from zero to DWC_RNK_CATEGORY_MAX).
region The region code. Specified as a DWCRnkRegion value.
score Score. Specifies an arbitrary numerical value.
data Pointer to the buffer for the user defined data.
size Size of data (equal to or less than DWC_RNK_DATA_MAX).

Return Values

DWC_RNK_SUCCESS Succeeded.
DWC_RNK_IN_ERROR An error is being generated.
DWC_RNK_ERROR_PUT_NOTREADY Communications could not be prepared.
DWC_RNK_ERROR_INVALID_PARAMETER Invalid parameter.
DWC_RNK_ERROR_PUT_INVALID_KEY Invalid encryption key.
DWC_RNK_ERROR_PUT_NOMEMORY Insufficient memory.

Description

Starts the asynchronous process for recording the score. Only one asynchronous process can be run at a time. DWC_RNK_ERROR_PUT_NOTREADY is returned if an attempt is made to execute more than one asynchronous process.

Make periodic calls to the DWC_RnkProcess function during the asynchronous process. During the process, DWC_RnkProcess returns DWC_RNK_SUCCESS.

Call the DWC_RnkGetState function to get the state of progress for the asynchronous process.

Be sure to make backups as necessary when executing asynchronous processes in succession because some members inside the DWCRnkData structure obtained using the DWC_RnkResGetRow function directly access the receive buffer.

Specify NULL for data and 0 for size when user-defined data is not used.

The size of the user-defined data designated in data is corrected to a size that is an integral multiple of 4 on the server. Thus, if 3 bytes is specified in size, 1 byte of dummy data will be added, and a total of 4 bytes will be recorded. The data size obtained by the DWC_RnkResGetRow function is this adjusted data size.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL