Common Utilities: Constants

Definitions


#include <dwc.h>


enum DWCError {
    DWC_ERROR_NONE                          =  0,
    DWC_ERROR_DS_MEMORY_ANY,
    DWC_ERROR_AUTH_ANY,
    DWC_ERROR_AUTH_OUT_OF_SERVICE,
    DWC_ERROR_AUTH_STOP_SERVICE,
    DWC_ERROR_AC_ANY,
    DWC_ERROR_NETWORK,
    DWC_ERROR_GHTTP_ANY,
    DWC_ERROR_DISCONNECTED,
    DWC_ERROR_FATAL,
    DWC_ERROR_FRIENDS_SHORTAGE,
    DWC_ERROR_NOT_FRIEND_SERVER,
    DWC_ERROR_SERVER_FULL,
    DWC_ERROR_ND_ANY,
    DWC_ERROR_ND_HTTP,
    DWC_ERROR_SVL_ANY,
    DWC_ERROR_SVL_HTTP,
    DWC_ERROR_PROF_ANY,
    DWC_ERROR_PROF_HTTP,
    DWC_ERROR_GDB_ANY,
    DWC_ERROR_SCL_ANY,
    DWC_ERROR_SC_CONNECT_BLOCK,
    DWC_ERROR_NETWORK_LIGHT,
    DWC_ERROR_NUM,
};

enum DWCErrorType {
    DWC_ETYPE_NO_ERROR                      =  0,
    DWC_ETYPE_LIGHT,
    DWC_ETYPE_SHOW_ERROR,
    DWC_ETYPE_SHUTDOWN_FM,
    DWC_ETYPE_SHUTDOWN_GHTTP,
    DWC_ETYPE_SHUTDOWN_ND,
    DWC_ETYPE_DISCONNECT,
    DWC_ETYPE_FATAL,
    DWC_ETYPE_NUM,
};

enum DWCReportFlag {
    DWC_REPORTFLAG_NONE                     =  0x00000000,
    DWC_REPORTFLAG_INFO                     =  0x00000001,
    DWC_REPORTFLAG_ERROR                    =  0x00000002,
    DWC_REPORTFLAG_DEBUG                    =  0x00000004,
    DWC_REPORTFLAG_WARNING                  =  0x00000008,
    DWC_REPORTFLAG_ACHECK                   =  0x00000010,
    DWC_REPORTFLAG_LOGIN                    =  0x00000020,
    DWC_REPORTFLAG_MATCH_NN                 =  0x00000040,
    DWC_REPORTFLAG_MATCH_GT2                =  0x00000080,
    DWC_REPORTFLAG_TRANSPORT                =  0x00000100,
    DWC_REPORTFLAG_QR2_REQ                  =  0x00000200,
    DWC_REPORTFLAG_SB_UPDATE                =  0x00000400,
    DWC_REPORTFLAG_SEND_INFO                =  0x00008000,
    DWC_REPORTFLAG_RECV_INFO                =  0x00010000,
    DWC_REPORTFLAG_UPDATE_SV                =  0x00020000,
    DWC_REPORTFLAG_CONNECTINET              =  0x00040000,
    DWC_REPORTFLAG_AUTH                     =  0x01000000,
    DWC_REPORTFLAG_AC                       =  0x02000000,
    DWC_REPORTFLAG_BM                       =  0x04000000,
    DWC_REPORTFLAG_UTIL                     =  0x08000000,
    DWC_REPORTFLAG_OPTION_CF                =  0x10000000,
    DWC_REPORTFLAG_OPTION_CONNTEST          =  0x20000000,
    DWC_REPORTFLAG_GAMESPY                  =  0x80000000,
    DWC_REPORTFLAG_TEST                     =  0x00100000,
    DWC_REPORTFLAG_ALL                      =  0xffffffff,
};

		

Error Enumerators

DWC_ERROR_NONE No error.
DWC_ERROR_DS_MEMORY_ANY Error related to system save data.
DWC_ERROR_AUTH_ANY Authentication-related error.
DWC_ERROR_AUTH_OUT_OF_SERVICE Service terminated.
DWC_ERROR_AUTH_STOP_SERVICE Service stopped temporarily.
DWC_ERROR_AC_ANY Error related to automatic connection.
DWC_ERROR_NETWORK Other network error.
DWC_ERROR_GHTTP_ANY HTTP communications (GameSpy HTTP) error.
DWC_ERROR_DISCONNECTED Disconnected.
DWC_ERROR_FATAL Fatal error.
DWC_ERROR_FRIENDS_SHORTAGE Tried to begin friend-specified matchmaking without enough valid friends for the specified number.
DWC_ERROR_NOT_FRIEND_SERVER With server-client matchmaking, either the server-specified friends are not mutual friends, or the server is down.
DWC_ERROR_SERVER_FULL The server-client matchmaking server has exceeded the maximum number of participants.
DWC_ERROR_ND_ANY Download library error.
DWC_ERROR_ND_HTTP Download library HTTP error.
DWC_ERROR_SVL_ANY Service locator error.
DWC_ERROR_SVL_HTTP HTTP communications error occurred while service locator information was being obtained.
DWC_ERROR_PROF_ANY Error occurring during the illegal string check when the server response was abnormal.
DWC_ERROR_PROF_HTTP Illegal string check HTTP error.
DWC_ERROR_GDB_ANY GDB library error. Normally does not occur with DWC.
DWC_ERROR_SCL_ANY SC library error. Normally does not occur with DWC.
DWC_ERROR_SC_CONNECT_BLOCK The server denied client connection during server-client matchmaking.
DWC_ERROR_NETWORK_LIGHT Network error to be handled as a light error.
DWC_ERROR_NUM

Error Types Indicating the Procedure Required on Error Detection

DWC_ETYPE_NO_ERROR No error.
DWC_ETYPE_LIGHT Only a game-specific display; error code display is not necessary.
To recover, call the DWC_ClearError function.
DWC_ETYPE_SHOW_ERROR Display the error code.
To recover, call the DWC_ClearError function.
DWC_ETYPE_SHUTDOWN_FM The FriendsMatch library must be shut down by calling the DWC_ShutdownFriendsMatch function. Display the error code.
DWC_ETYPE_SHUTDOWN_GHTTP Call the following library release functions as needed.
DWC_RnkShutdown function (General-Purpose Ranking library)
Display the error code.
DWC_ETYPE_SHUTDOWN_ND You must call the DWC_NdCleanupAsync function and terminate the Download library. Display the error code.
DWC_ETYPE_DISCONNECT Call the following library release functions as needed.
DWC_ShutdownFriendsMatch function (FriendsMatch library)
DWC_NdCleanupAsync function (Download library)
DWC_RnkShutdown function (General-Purpose Ranking library).
Communication must be terminated later using the DWC_CleanupInet or DWC_CleanupInetAsync function. Display the error code.
DWC_ETYPE_FATAL Because this is equivalent to a FatalError, when using NITRO, you must prompt the user to turn power OFF. When using TWL, you must prompt the user to reset (return to the launcher). Display the error code.
DWC_ETYPE_NUM

Flag for Outputting DWC Debug Information

DWC_REPORTFLAG_NONE No output
DWC_REPORTFLAG_INFO Information
DWC_REPORTFLAG_ERROR Error
DWC_REPORTFLAG_DEBUG Debug information
DWC_REPORTFLAG_WARNING Warning
DWC_REPORTFLAG_ACHECK GameSpy server availability check
DWC_REPORTFLAG_LOGIN Login-related
DWC_REPORTFLAG_MATCH_NN Matchmaking-NN-related
DWC_REPORTFLAG_MATCH_GT2 Matchmaking-GT2-related
DWC_REPORTFLAG_TRANSPORT Send/receive-related
DWC_REPORTFLAG_QR2_REQ QR2-related
DWC_REPORTFLAG_SB_UPDATE SB-related
DWC_REPORTFLAG_SEND_INFO Send information
DWC_REPORTFLAG_RECV_INFO Receive information
DWC_REPORTFLAG_UPDATE_SV Server update-related
DWC_REPORTFLAG_CONNECTINET Internet connection-related
DWC_REPORTFLAG_AUTH Authentication-related
DWC_REPORTFLAG_AC Account-related
DWC_REPORTFLAG_BM Saving/loading Wi-Fi settings
DWC_REPORTFLAG_UTIL UTIL-related
DWC_REPORTFLAG_OPTION_CF Not used
DWC_REPORTFLAG_OPTION_CONNTEST Not used
DWC_REPORTFLAG_GAMESPY GameSpy-related
DWC_REPORTFLAG_TEST
DWC_REPORTFLAG_ALL All

Revision History

5.2
Added explanation of flags for debug information output.

CONFIDENTIAL