Share via


ReadResult Class

Definition

A result returned from a setting value read.

[MessagePack.MessagePackObject(false)]
public class ReadResult : IEquatable<Microsoft.VisualStudio.RpcContracts.UnifiedSettings.ReadResult>
[<MessagePack.MessagePackObject(false)>]
type ReadResult = class
    interface IEquatable<ReadResult>
Public Class ReadResult
Implements IEquatable(Of ReadResult)
Inheritance
ReadResult
Attributes
MessagePack.MessagePackObjectAttribute
Implements

Constructors

ReadResult(ReadResult)
ReadResult(ReadResultCode, String, SettingValue, SettingValueMetaData, String)

A result returned from a setting value read.

Properties

EqualityContract
IsSuccess

Gets a value indicating whether the read result is a success.

MetaData

MetaData about the read value.

Moniker

The moniker of the setting.

ResultCode

The code indicating the outcome of the read.

ValidationErrorMessage

When ResultCode is FailedValidation, contains an optional validation error.

Value

The read value.

Methods

<Clone>$()
Deconstruct(ReadResultCode, String, SettingValue, SettingValueMetaData, String)
Equals(Object)
Equals(ReadResult)
FailedValidation(String, String)

Creates a new instance of ReadResult with a failed validation result code.

GetHashCode()
NotPersisted(String)

Creates a new instance of ReadResult with a not persisted result code.

NotRegistered(String)

Creates a new instance of ReadResult with a not registered result code.

PrintMembers(StringBuilder)
Success(String, SettingValue, SettingValueMetaData)

Creates a new instance of ReadResult with a success result code.

ToString()

Operators

Equality(ReadResult, ReadResult)
Inequality(ReadResult, ReadResult)

Applies to