General-Purpose Ranking - Constants

Definition


#include <dwc.h>

#define   DWC_RNK_DATA_MAX                        764
#define   DWC_RNK_CATEGORY_MAX                    1000
#define   DWC_RNK_GET_MAX                         30
#define   DWC_RNK_FRIENDS_MAX                     64

enum  {
    DWC_RNK_ORDER_ASC                       	0
    DWC_RNK_ORDER_DES                       	1
};

enum DWCRnkError {
    DWC_RNK_SUCCESS                          0
    DWC_RNK_IN_ERROR
    DWC_RNK_ERROR_INVALID_PARAMETER
    DWC_RNK_ERROR_INIT_ALREADYINITIALIZED
    DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE
    DWC_RNK_ERROR_INIT_INVALID_INITDATA
    DWC_RNK_ERROR_INIT_INVALID_USERDATA
    DWC_RNK_ERROR_PUT_NOTREADY
    DWC_RNK_ERROR_PUT_INVALID_KEY
    DWC_RNK_ERROR_PUT_NOMEMORY
    DWC_RNK_ERROR_GET_NOTREADY
    DWC_RNK_ERROR_GET_INVALID_KEY
    DWC_RNK_ERROR_GET_NOMEMORY
    DWC_RNK_ERROR_CANCEL_NOTASK
    DWC_RNK_PROCESS_NOTASK
    DWC_RNK_PROCESS_TIMEOUT
    DWC_RNK_ERROR_INVALID_MODE
    DWC_RNK_ERROR_NOTCOMPLETED
    DWC_RNK_ERROR_EMPTY_RESPONSE
};

enum DWCRnkState {
    DWC_RNK_STATE_NOTREADY                   0
    DWC_RNK_STATE_INITIALIZED
    DWC_RNK_STATE_PUT_ASYNC
    DWC_RNK_STATE_GET_ASYNC
    DWC_RNK_STATE_COMPLETED
    DWC_RNK_STATE_TIMEOUT
    DWC_RNK_STATE_ERROR
};

enum DWCRnkRegion {
    DWC_RNK_REGION_JP                        0x01
    DWC_RNK_REGION_US                        0x02
    DWC_RNK_REGION_EU                        0x04
    DWC_RNK_REGION_KR                        0x08
    DWC_RNK_REGION_CH                        0x10
    DWC_RNK_REGION_ALL                       0xff
};

enum DWCRnkGetMode {
    DWC_RNK_GET_MODE_ORDER
    DWC_RNK_GET_MODE_TOPLIST
    DWC_RNK_GET_MODE_NEAR
    DWC_RNK_GET_MODE_FRIENDS
    DWC_RNK_GET_MODE_NEAR_HI
    DWC_RNK_GET_MODE_NEAR_LOW
};

Constants

DWC_RNK_DATA_MAX Maximum size to be used for user-defined data.
DWC_RNK_CATEGORY_MAX Maximum value that can be specified for a category.
DWC_RNK_GET_MAX Upper limit on the number of rankings that can be retrieved.
DWC_RNK_FRIENDS_MAX Maximum number of friends.

Constants Indicating Ascending and Descending Order of the Ranking List to be Retrieved

DWC_RNK_ORDER_ASC Ascending order.
DWC_RNK_ORDER_DES Descending order.

Error Codes

DWC_RNK_SUCCESS Succeeded.
DWC_RNK_IN_ERROR An error is occurring.
DWC_RNK_ERROR_INVALID_PARAMETER Invalid parameter.
DWC_RNK_ERROR_INIT_ALREADYINITIALIZED Initialized.
DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE Invalid initial data size.
DWC_RNK_ERROR_INIT_INVALID_INITDATA Invalid initial data.
DWC_RNK_ERROR_INIT_INVALID_USERDATA Invalid user information.
DWC_RNK_ERROR_PUT_NOTREADY Not initialized.
DWC_RNK_ERROR_PUT_INVALID_KEY Invalid encryption key.
DWC_RNK_ERROR_PUT_NOMEMORY Insufficient memory.
DWC_RNK_ERROR_GET_NOTREADY Not initialized.
DWC_RNK_ERROR_GET_INVALID_KEY Invalid encryption key.
DWC_RNK_ERROR_GET_NOMEMORY Insufficient memory.
DWC_RNK_ERROR_CANCEL_NOTASK No processing during asynchronous processing.
DWC_RNK_PROCESS_NOTASK No processing during asynchronous processing.
DWC_RNK_PROCESS_TIMEOUT Timeout.
DWC_RNK_ERROR_INVALID_MODE Invalid mode.
DWC_RNK_ERROR_NOTCOMPLETED Communications not completed.
DWC_RNK_ERROR_EMPTY_RESPONSE Empty response.

Module Status

DWC_RNK_STATE_NOTREADY Uninitialized.
DWC_RNK_STATE_INITIALIZED Initialized.
DWC_RNK_STATE_PUT_ASYNC Currently executing asynchronous PUT process.
DWC_RNK_STATE_GET_ASYNC Currently executing asynchronous GET process.
DWC_RNK_STATE_COMPLETED Done.
DWC_RNK_STATE_TIMEOUT Timeout.
DWC_RNK_STATE_ERROR Error occurred.

Region Codes

DWC_RNK_REGION_JP Japan
DWC_RNK_REGION_US North America
DWC_RNK_REGION_EU Europe
DWC_RNK_REGION_KR Korea
DWC_RNK_REGION_CH China
DWC_RNK_REGION_ALL World

Modes for Getting DWC_RnkGetScoreAsync

DWC_RNK_GET_MODE_ORDER Order.
DWC_RNK_GET_MODE_TOPLIST High score.
DWC_RNK_GET_MODE_NEAR Nearby scores.
DWC_RNK_GET_MODE_FRIENDS Ranking with friends specified.
DWC_RNK_GET_MODE_NEAR_HI Nearby scores (higher than one's own ranking).
DWC_RNK_GET_MODE_NEAR_LOW Nearby scores (lower than one's own ranking).

CONFIDENTIAL