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 the corresponding parameters based on the acquisition mode.
When the get mode is DWC_RNK_GET_MODE_ORDER, the value is set below DWCRnkGetParam.order.
When the get mode is DWC_RNK_GET_MODE_TOPLIST, the value is set below DWCRnkGetParam.toplist.
When the get mode is DWC_RNK_GET_MODE_NEAR, the value is set below DWCRnkGetParam.near.
When the get mode is DWC_RNK_GET_MODE_FRIENDS, the value is set below DWCRnkGetParam.friends.

size The subsequent data size (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)
limit Specifies the maximum to obtain. This value must be DWC_RNK_GET_MAX(10) or lower. The lower limit differs based on the acquisition mode. It is 1 for DWC_RNK_GET_MODE_TOPLIST, and 2 for DWC_RNK_GET_MODE_NEAR and DWC_RNK_GET_MODE_FRIENDS.
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

07/24/2006 Added description of the maximum limit value
04/14/2006 Initial version


CONFIDENTIAL