I3DHError.h File Reference

instant3Dhub: I3DHError.h File Reference
instant3Dhub
I3DHError.h File Reference
#include "CoreMinimal.h"
#include "I3DHError.generated.h"
+ Include dependency graph for I3DHError.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Detailed Description

Enumerations

enum class  EI3DHErrorCode : uint32 {
  Success = 0 , InvalidObjectId = 1 , InvalidProperty = 2 , InvalidValueType = 3 ,
  InvalidValue = 4 , PropertyNotSet = 5 , NoSessionConnection = 6 , SerializationError = 0x00010000 ,
  JavascriptError = 0x00010000 + 1 , Aborted = 0x00010000 + 2 , NotImplementedInBackend = 0x00010000 + 3 , InternalError01 = 0x00020000 ,
  InternalError02 , InternalError03 , InternalError04 , InternalError05 ,
  InternalError06 , InternalError07 , InternalError08 , InternalError09 ,
  InternalError10 , InternalError11 , InternalError12 , InternalError13 ,
  InternalError14 , InternalError15 , InternalError16 , UnknownError = 0x80000000
}
 

Functions

FString I3DHStringFromErrorCode (EI3DHErrorCode ErrorCode)
 

Enumeration Type Documentation

◆ EI3DHErrorCode

enum class EI3DHErrorCode : uint32
strong

Enumeration of Error Codes returned from various instant3Dhub API Calls.

Enumerator
Success 

Success.

Operation was successful.

InvalidObjectId 

Invalid object Identifier.

InvalidProperty 

Invalid property.

InvalidValueType 

Invalid value type.

InvalidValue 

Invalid value.

PropertyNotSet 

Property not set.

NoSessionConnection 

No session connection.

SerializationError 

Serialization error.

JavascriptError 

Operation failed because of a JavaScript error.

See log file for more information.

Aborted 

Operation was aborted.

Status is unknown (e.g. commands may have already been sent to the session), but should be treated like the operation failed if necessary. Typically caused by disconnection.

NotImplementedInBackend 

Operation is not implemented in the active backend.

UnknownError 

Unknown error.

Function Documentation

◆ I3DHStringFromErrorCode()

FString I3DHStringFromErrorCode ( EI3DHErrorCode ErrorCode)

Converts an ErrorCode to a human-readable String.

Parameters
ErrorCodeThe error code.
Returns
String of the ErrorCode.