DayZ 1.24
Loading...
Searching...
No Matches
Protected Member Functions | Protected Attributes | Private Attributes | List of all members
ErrorProperties Class Reference

Class which holds the properties and handling of an error. More...

Collaboration diagram for ErrorProperties:
[legend]

Protected Member Functions

void ErrorProperties (string message, string serverMessage)
 
void HandleError (int errorCode, string additionalInfo="")
 
string GetClientMessage (string additionalInfo="")
 
string GetServerMessage (string additionalInfo="")
 

Protected Attributes

string m_Message
 Message which will appear on Client.
 
string m_ServerMessage
 Message which will appear on Server.
 

Private Attributes

const string EP_HEADER_FORMAT_STRING = "%1 (%2)"
 Formating for header (%1 = Header; %2 = ErrorCode)
 
const string EP_MESSAGE_FORMAT_STRING = "%1\n(%2)"
 Formating for message (%1 = Message; %2 = AdditionalInfo)
 

Detailed Description

Class which holds the properties and handling of an error.

Definition at line 2 of file ErrorProperties.c.

Constructor & Destructor Documentation

◆ ErrorProperties()

void ErrorProperties::ErrorProperties ( string message,
string serverMessage )
inlineprotected

Definition at line 10 of file ErrorProperties.c.

11 {
12 m_Message = message;
13 m_ServerMessage = serverMessage;
14 }
ErrorProperties::m_ServerMessage
string m_ServerMessage
Message which will appear on Server.
Definition ErrorProperties.c:8
ErrorProperties::m_Message
string m_Message
Message which will appear on Client.
Definition ErrorProperties.c:7

References m_Message, and m_ServerMessage.

Member Function Documentation

◆ GetClientMessage()

string ErrorProperties::GetClientMessage ( string additionalInfo = "")
inlineprotected

Definition at line 18 of file ErrorProperties.c.

19 {
20 if (additionalInfo != "")
21 return string.Format(EP_MESSAGE_FORMAT_STRING, m_Message, additionalInfo);
22 else
23 return m_Message;
24 }
ErrorProperties::EP_MESSAGE_FORMAT_STRING
const string EP_MESSAGE_FORMAT_STRING
Formating for message (%1 = Message; %2 = AdditionalInfo)
Definition ErrorProperties.c:5

References EP_MESSAGE_FORMAT_STRING, string::Format(), and m_Message.

◆ GetServerMessage()

string ErrorProperties::GetServerMessage ( string additionalInfo = "")
inlineprotected

Definition at line 26 of file ErrorProperties.c.

27 {
28 if (additionalInfo != "")
29 return string.Format(EP_MESSAGE_FORMAT_STRING, m_ServerMessage, additionalInfo);
30 else
31 return m_ServerMessage;
32 }

References EP_MESSAGE_FORMAT_STRING, string::Format(), and m_ServerMessage.

◆ HandleError()

void ErrorProperties::HandleError ( int errorCode,
string additionalInfo = "" )
inlineprotected

Definition at line 16 of file ErrorProperties.c.

16{}

Member Data Documentation

◆ EP_HEADER_FORMAT_STRING

const string ErrorProperties::EP_HEADER_FORMAT_STRING = "%1 (%2)"
private

Formating for header (%1 = Header; %2 = ErrorCode)

Definition at line 4 of file ErrorProperties.c.

◆ EP_MESSAGE_FORMAT_STRING

const string ErrorProperties::EP_MESSAGE_FORMAT_STRING = "%1\n(%2)"
private

Formating for message (%1 = Message; %2 = AdditionalInfo)

Definition at line 5 of file ErrorProperties.c.

Referenced by GetClientMessage(), and GetServerMessage().

◆ m_Message

string ErrorProperties::m_Message
protected

Message which will appear on Client.

Definition at line 7 of file ErrorProperties.c.

Referenced by ErrorProperties(), GetClientMessage(), GetHeader(), and HandleError().

◆ m_ServerMessage

string ErrorProperties::m_ServerMessage
protected

Message which will appear on Server.

Definition at line 8 of file ErrorProperties.c.

Referenced by ErrorProperties(), and GetServerMessage().

The documentation for this class was generated from the following file: