1. Epic GamesDeveloper
  3. FOnlineError

FOnlineError

Generic Error response for OSS calls

API > API/Plugins > API/Plugins/OnlineSubsystem

References

   
Module OnlineSubsystem
Header /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineError.h
Include #include "OnlineError.h"

Syntax

struct FOnlineError

Remarks

Generic Error response for OSS calls

Variables

  Type Name Description
Public variable bool bSucceeded Did the request succeed fully. If this is true the rest of the struct probably doesn't matter
Public variable FString ErrorCode Intended to be interpreted by code.
Public variable FText ErrorMessage Suitable for display to end user. Guaranteed to be in the current locale (or empty)
Public variable FString ErrorRaw The raw unparsed error message from server.
Protected variable EOnlineErrorResult Result If successful result then the rest of the struct probably doesn't matter

Constructors

  Type Name Description
Public function  

FOnlineError ( const TCHAR*const ErrorCode
)

  
Public function  

FOnlineError ( const int32 ErrorCode
)

 Generic Error response for OSS calls
Public function    
Public function  

FOnlineError ( bool bSucceeded
)

  
Public function  

FOnlineError ( const FString& ErrorCode
)

 Generic Error response for OSS calls
Public function  

FOnlineError ( FString&& ErrorCode
)

 Generic Error response for OSS calls
Public function  

FOnlineError ( const FText& ErrorMessage
)

 Generic Error response for OSS calls

Functions

  Type Name Description
Public function Static FOnlineError

CreateError ( const FString& ErrorNamespace,
EOnlineErrorResult Result,
const FString& ErrorCode,
const FText& ErrorMessage
)

 Create factory for proper namespacing. Use ONLINE_ERROR macro
Public function Static FOnlineError

CreateError ( const FString& ErrorNamespace,
EOnlineErrorResult Result
)

 Use a default error code / display text
Protected function Static FString  
Protected function Static FText Default messaging for common errors
Protected function Static const FString & Default namespace for online errors
Public function Const const FString &  
Public function FString Prints out everything, need something like this!!!
Public function Const const FText &  
Public function Const const FString &  
Public function Const EOnlineErrorResult Accessors
Public function Static const FString Code useful when all you have is raw error info from old APIs
Protected function FOnlineError &

SetErrorCode ( const FString& Val
)

  
Protected function FOnlineError &

SetErrorMessage ( const FText& Val
)

  
Public function FOnlineError &

SetErrorRaw ( const FString& Val
)

 Setters for adding the raw error
Public function void

SetFromErrorCode ( const int32 ErrorCode
)

  
Public function void

SetFromErrorCode ( const FString& ErrorCode
)

 Same as the Ctors but can be called any time (does NOT set bSucceeded to false)
Public function void

SetFromErrorCode ( FString&& ErrorCode
)

  
Protected function void Helpers for constructing errors
Protected function void

SetFromErrorCode ( EOnlineErrorResult InResult,
const FString& InErrorCode
)

  
Protected function void

SetFromErrorCode ( EOnlineErrorResult InResult,
const FString& InErrorCode,
const FText& InErrorText
)

  
Public function void

SetFromErrorMessage ( const FText& ErrorMessage
)

  
Public function void

SetFromErrorMessage ( const FText& ErrorMessage,
const int32 ErrorCode
)

  
Protected function FOnlineError & Setters for updating individual values directly
Public function Static const FOnlineError &

Success ()

 Helpers for the most common error types
Public function Const FString Call this if you want to log this out (will pick the best string representation)
Public function Const bool  

Operators

  Type Name Description
Public function Const bool

operator!= ( const FOnlineError& Other
)

  
Public function Const FOnlineError

operator+ ( const FString& RHS
)

  
Public function Const FOnlineError

operator+ ( const FOnlineError& RHS
)

  
Public function FOnlineError &

operator+= ( const FString& RHS
)

  
Public function FOnlineError &

operator+= ( const FOnlineError& RHS
)

  
Public function Const bool

operator== ( const FOnlineError& Other
)

  

Constants

Name Description
GenericErrorCode Code useful when all you have is raw error info from old APIs

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page