Export (0) Print
Expand All

UTF32Encoding.GetBytes Method (Char*, Int32, Byte*, Int32)

Encodes a set of characters starting at the specified character pointer into a sequence of bytes that are stored starting at the specified byte pointer.

This API is not CLS-compliant. 

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

[<CLSCompliantAttribute(false)>]
abstract GetBytes : 
        chars:nativeptr<char> * 
        charCount:int * 
        bytes:nativeptr<byte> * 
        byteCount:int -> int 
[<CLSCompliantAttribute(false)>]
override GetBytes : 
        chars:nativeptr<char> * 
        charCount:int * 
        bytes:nativeptr<byte> * 
        byteCount:int -> int

Parameters

chars
Type: System.Char*

A pointer to the first character to encode.

charCount
Type: System.Int32

The number of characters to encode.

bytes
Type: System.Byte*

A pointer to the location at which to start writing the resulting sequence of bytes.

byteCount
Type: System.Int32

The maximum number of bytes to write.

Return Value

Type: System.Int32
The actual number of bytes written at the location indicated by the bytes parameter.

ExceptionCondition
ArgumentNullException

chars is a null reference (Nothing in Visual Basic).

-or-

bytes is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

charCount or byteCount is less than zero.

ArgumentException

Error detection is enabled, and chars contains an invalid sequence of characters.

-or-

byteCount is less than the resulting number of bytes.

EncoderFallbackException

A fallback occurred (see Character Encoding in the .NET Framework for complete explanation)

-and-

EncoderFallback is set to EncoderExceptionFallback.

To calculate the exact array size required by GetBytes to store the resulting bytes, the application uses GetByteCount. To calculate the maximum array size, the application should use GetMaxByteCount. The GetByteCount method generally allows allocation of less memory, while the GetMaxByteCount method generally executes faster.

With error detection, an invalid sequence causes this method to throw a ArgumentException. Without error detection, invalid sequences are ignored, and no exception is thrown.

Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application uses the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.

NoteNote

To ensure that the encoded bytes are decoded properly, the application should prefix encoded bytes with a preamble.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

  • SecurityCriticalAttribute 

    Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft