DWC_RnkPutScoreAsync

Syntax


#include <dwc.h>

DWCRnkError    DWC_RnkPutScoreAsync( u32              category,
                                     DWCRnkRegion     region,
                                     s32              score,
                                     void*            data,
                                     u32              size );
				

Description

Starts the asynchronous process for recording the score. Only one asynchronous process can be run at a time. If you attempt to run multiple asynchronous processes at the same time, the function will return DWC_RNK_ERROR_PUT_NOTREADY.

Make periodic calls to the DWC_RnkProcess function during the asynchronous process. During processing, DWC_RnkProcess will return DWC_RNK_SUCCESS.

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

Because the Receive buffer directly references some of the members in the DWCRnkData structure that the DWC_RnkResGetRow function gets, the use of that buffer should be avoided as much as possible when performing asynchronous processes.

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, then 1 byte of dummy data will be added and 4 bytes will be registered. The data size obtained by the DWC_RnkResGetRow function is this adjusted data size.

Arguments

category The category ID for differentiating rankings (a numerical value between 0 and DWC_RNK_CATEGORY_MAX).
region The region code. Specified from inside DWCRnkRegion.
score The score. Specifies an arbitrary numerical value.
data Pointer to the buffer for the user defined data.
size The size of 'data' (less than or equal to 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.

See Also

DWC_RnkResGetRow
DWC_RnkGetState
DWC_RnkProcess
DWC_RnkCancelProcess

Revision History

2006/07/21 Added guideline-related information.
2006/06/22 Added the description of a case where user-defined data is not used.
2006/06/20 Corrected errors.
2006/04/14 Initial version.


CONFIDENTIAL