ErrorMessages.GetMessageForError Method

GetMessageForError returns a developer-friendly error string corresponding to the provided networking error code. This API is provided as part of the secure sockets API, for developers to use to get more information about secure socket API failures. It is not suitable for retrieving error strings for other APIs. The strings are not appropriate for showing to end-users, and should be used for debugging purposes only.

Syntax

public:
static String^ GetMessageForError(
         uint32 errorCode
)  

Parameters

errorCode
Type: uint32 

 A networking error code.

Return value

Type: String 

  A string describing the error. If errorCode is not recognized, GetMessageForError returns a generic error string. Invalid input values may cause GetMessageForError to throw a COM exception.

Requirements

Namespace: Windows.Xbox.Networking

Metadata: windows.winmd

See also

Reference

ErrorMessages Class

ErrorMessages Members

Windows.Xbox.Networking Namespace