DWC_RnkResGetOrder

Syntax

#include <dwc.h>
DWCRnkError DWC_RnkResGetOrder(u32 *order);

Arguments

order Pointer to the variable that gets the ranking.

Return Values

DWC_RNK_SUCCESS Succeeded.
DWC_RNK_IN_ERROR An error is being generated.
DWC_RNK_ERROR_INVALID_MODE Invalid mode.
DWC_RNK_ERROR_INVALID_PARAMETER Invalid parameter.
DWC_RNK_ERROR_NOTCOMPLETED Communications not completed.
DWC_RNK_ERROR_EMPTY_RESPONSE Empty response.

Description

Gets the local host's ranking, which the DWC_RnkGetScoreAsync function received as a result of making a request in order retrieval mode (DWC_RNK_GET_MODE_ORDER), also called "get rank" mode.

This function fails if the request was made with anything other than order retrieval ("get rank") mode.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL