Class Error

Indicator that there has been an error in the system, either due to the last message/query sent, or due to an internal error.

Inheritance

Object

ButtplugMessage

Error

Implements

IButtplugMessageOutgoingOnly

Inherited Members

ButtplugMessage.Id

ButtplugMessage.Name

ButtplugMessage.GetName(Type)

Namespace: Buttplug.Core.Messages

Assembly: Buttplug.dll

Syntax

public class Error : ButtplugMessage, IButtplugMessageOutgoingOnly

Constructors

Error(String, Error.ErrorClass, UInt32)

Initializes a new instance of the Error class. The message ID may be zero if raised outside of servicing a message from the client, otherwise the message ID must match the message being serviced.

Declaration

public Error(string errorMessage, Error.ErrorClass errorCode, uint id)

Parameters

Type	Name	Description
String	errorMessage	Human-readable error description.
Error.ErrorClass	errorCode	Class of error.
UInt32	id	Message ID.

Fields

ErrorCode

Specific error type this message describes.

Declaration

public Error.ErrorClass ErrorCode

Field Value

Type	Description
Error.ErrorClass

ErrorMessage

Human-readable error description.

Declaration

public string ErrorMessage

Field Value

Type	Description
String

Implements

IButtplugMessageOutgoingOnly