DWCRnkError

Definition


#include <dwc.h>

typedef enum{

    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_NOTINITIALIZED,
    DWC_RNK_ERROR_PUT_INVALID_KEY,
    DWC_RNK_ERROR_PUT_NOMEMORY,
    
    DWC_RNK_ERROR_GET_NOTINITIALIZED,
    DWC_RNK_ERROR_GET_INVALID_KEY,
    DWC_RNK_ERROR_GET_NOMEMORY,

    DWC_RNK_ERROR_CANCEL_NOTASK,

    DWC_RNK_PROCESS_NOTASK,

    DWC_RNK_ERROR_INVALID_MODE,
    DWC_RNK_ERROR_NOTCOMPLETED,
    DWC_RNK_ERROR_EMPTY_RESPONSE

} DWCRnkError;
				

Description

The enumeration type that defines the error codes for general-purpose ranking.

DWC_RNK_SUCCESS Success
DWC_RNK_IN_ERROR An error is being generated.
DWC_RNK_ERROR_INVALID_PARAMETER An invalid parameter
DWC_RNK_ERROR_INIT_ALREADYINITIALIZED DWC_RnkInitialize is initialized.
DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE Invalid initialization data size for DWC_RnkInitialize
DWC_RNK_ERROR_INIT_INVALID_INITDATA Invalid initialization data for DWC_RnkInitialize
DWC_RNK_ERROR_INIT_INVALID_USERDATA Invalid user data for DWC_RnkInitialize.
The user data must contain a valid GameSpy Profile ID. This error is generated if the data includes a temporary ID that has never been used before to log in with.
DWC_RNK_ERROR_PUT_NOTINITIALIZED DWC_RnkPutScoreAsync is not initialized.
DWC_RNK_ERROR_PUT_INVALID_KEY Invalid encryption key for DWC_RnkPutScoreAsync.
DWC_RNK_ERROR_PUT_NOMEMORY Insufficient memory for DWC_RnkPutScoreAsync
DWC_RNK_ERROR_GET_NOTINITIALIZED DWC_RnkGetScoreAsync is not initialized.
DWC_RNK_ERROR_GET_INVALID_KEY Invalid encryption key for DWC_RnkGetScoreAsync
DWC_RNK_ERROR_GET_NOMEMORY Insufficient memory for DWC_RnkGetScoreAsync
DWC_RNK_ERROR_CANCEL_NOTASK There is no asynchronous process currently processing for DWC_RnkCancelProcess.
DWC_RNK_PROCESS_NOTASK There is no asynchronous process currently processing for DWC_RnkProcess .
DWC_RNK_ERROR_INVALID_MODE Invalid mode
DWC_RNK_ERROR_NOTCOMPLETED Communications not completed
DWC_RNK_ERROR_EMPTY_RESPONSE Empty response

See Also

DWC_RnkInitialize DWC_RnkPutScoreAsync DWC_RnkGetScoreAsync DWC_RnkCancelProcess DWC_RnkProcess

Revision History

2006/07/24 Integrated terminology
2006/06/20 Corrected errors
2006/04/14 Initial version


CONFIDENTIAL