DWCRnkGetParam

Definition


#include <dwc.h>

typedef struct{
    u32             size;
    union{
        u32         data;
        struct{
            u32 sort;
            u32 since;
        }           order;
        struct{
            u32 sort;
            u32 limit;
            u32 since;
        }           toplist;
        struct{
            u32 sort;
            u32 limit;
            u32 since;
        }           near;
        struct{
            u32 sort;
            u32 limit;
            u32 since;
            s32 friends[64];
        }           friends;
    };
} DWCRnkGetParam;
				

Description

This structure stores the parameter specified by the DWC_RnkGetScoreAsync function. It sets values in corresponding parameters depending on the the get mode.
When the get mode is DWC_RNK_GET_MODE_ORDER, a value of DWCRnkGetParam.order or lower is set.
When the get mode is DWC_RNK_GET_MODE_TOPLIST, a value of DWCRnkGetParam.toplist or lower is set.
When the get mode is DWC_RNK_GET_MODE_NEAR, a value of DWCRnkGetParam.near or lower is set.
When the get mode is DWC_RNK_GET_MODE_FRIENDS, a value of DWCRnkGetParam.friends or lower is set.
When the get mode is DWC_RNK_GET_MODE_NEAR_HI, a value of DWCRnkGetParam.near or lower is set.
When the get mode is DWC_RNK_GET_MODE_NEAR_LOW, a value of DWCRnkGetParam.near or lower is set.

size Size of the subsequent data (shared).
When the get mode is DWC_RNK_GET_MODE_ORDER, the size is:
sizeof(DWCRnkGetParam.order)
When the get mode is DWC_RNK_GET_MODE_TOPLIST, the size is:
sizeof(DWCRnkGetParam.toplist)
When the get mode is DWC_RNK_GET_MODE_NEAR, the size is:
sizeof(DWCRnkGetParam.near)
When the get mode is DWC_RNK_GET_MODE_FRIENDS, the size is:
sizeof(DWCRnkGetParam.friends)
When the get mode is DWC_RNK_GET_MODE_NEAR_HI, the size is:
sizeof(DWCRnkGetParam.near)
When the get mode is DWC_RNK_GET_MODE_NEAR_LOW, the size is: sizeof(DWCRnkGetParam.near)
limit Specifies the maximum to obtain. This value must be DWC_RNK_GET_MAX(30) or lower. The lower limit differs based on the acquisition mode. It is 1 for DWC_RNK_GET_MODE_TOPLIST, whereas it is 2 for DWC_RNK_GET_MODE_NEAR, DWC_RNK_GET_MODE_FRIENDS, DWC_RNK_GET_MODE_NEAR_HI, and DWC_RNK_GET_MODE_NEAR_LOW.
sort The sort order:
DWC_RNK_ORDER_ASC = ascending
DWC_RNK_ORDER_DES = descending.
since Gets the rankings from data that have been updated in the past number of minutes specified. If 0 is specified, gets rankings from all the data.
friends[64] The list of GS profile IDs of friends.
If the list has fewer than 64 entries, store entries from the start of the list and zero-fill the remaining region.

See Also

DWC_RnkGetScoreAsync

Revision History

2007/07/21 Added descriptions about DWC_RNK_GET_MODE_NEAR_HI and DWC_RNK_GET_MODE_NEAR_LOW.
2007/07/21 Changed DWC_RNK_GET_MAX from 10 to 30.
2006/07/24 Added a description about the maximum value of limit.
2006/04/14 Initial version.


CONFIDENTIAL