EBError Type

This type defines details of the error.

Remarks

The fields below provide various information about the error.

Fields

Category
String

The category of error. Typical values include "Content", "Packaging", "UnPackaging", "Communication", and "InternalProcess". This value is optional.

Code
String

The error code. This value is required. The standard format is "EBMS:0001", where "0001" is the numeric code portion.

Description
String

The description of the error. This value is optional.

Detail
String

Additional details about the error. This may include other helpful information such as a stack trace. This value is optional.

Origin
String

The module within which the error occurred. Typical values include "ebMS", "reliability", and "security". This value is optional.

RefMessageId
String

The MessageId to which the error applies. This is optional but should be supplied if possible.

Severity
EBSeverityTypes

The severity of the error. Possible values are:

  • 0 (ebstWarning - default)
  • 1 (ebstFailure)
This value is required.

ShortDescription
String

A short description of the error. This may be helpful for logging or readability. This value is optional.

Constructors

public EBError();
Public EBError()
public EBError(string code, int severity);
Public EBError(ByVal Code As String, ByVal Severity As Integer)
public EBError(string code, int severity, string detail, string shortDescription);
Public EBError(ByVal Code As String, ByVal Severity As Integer, ByVal Detail As String, ByVal ShortDescription As String)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 .NET Edition - Version 20.0 [Build 8203]