This documentation is archived and is not being maintained.

EncoderReplacementFallbackBuffer Class

Represents a substitute input string that is used when the original input character cannot be encoded. This class cannot be inherited.


Namespace:  System.Text
Assembly:  mscorlib (in mscorlib.dll)

public sealed class EncoderReplacementFallbackBuffer : EncoderFallbackBuffer

The EncoderReplacementFallbackBuffer type exposes the following members.

Public methodEncoderReplacementFallbackBufferInitializes a new instance of the EncoderReplacementFallbackBuffer class using the value of a EncoderReplacementFallback object.

Public propertyRemainingGets the number of characters in the replacement fallback buffer that remain to be processed. (Overrides EncoderFallbackBuffer.Remaining.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodFallback(Char, Int32)Prepares the replacement fallback buffer to use the current replacement string. (Overrides EncoderFallbackBuffer.Fallback(Char, Int32).)
Public methodFallback(Char, Char, Int32)Indicates whether a replacement string can be used when an input surrogate pair cannot be encoded, or whether the surrogate pair can be ignored. Parameters specify the surrogate pair and the index position of the pair in the input. (Overrides EncoderFallbackBuffer.Fallback(Char, Char, Int32).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetNextCharRetrieves the next character in the replacement fallback buffer. (Overrides EncoderFallbackBuffer.GetNextChar().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMovePreviousCauses the next call to the GetNextChar method to access the character position in the replacement fallback buffer prior to the current character position. (Overrides EncoderFallbackBuffer.MovePrevious().)
Public methodResetInitializes all internal state information and data in this instance of EncoderReplacementFallbackBuffer. (Overrides EncoderFallbackBuffer.Reset().)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

It might not be possible to convert a character to an equivalent encoded byte sequence if no suitable encoding exists. A common reason for an encoding to fail is if the conversion operation uses a code page that cannot represent the character to encode.

If the input character cannot be converted to an output byte sequence, a System.Text.EncoderReplacementFallback object provides a replacement string that is substituted for the original input character. The replacement string initializes the value of the EncoderReplacementFallback object, and the value of the EncoderReplacementFallback object initializes the value of an EncoderReplacementFallbackBuffer object. The value of an EncoderReplacementFallbackBuffer object is called the replacement fallback buffer. The conversion operation encodes the replacement fallback buffer instead of the original input character, then continues to process the remainder of the input.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.