Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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

Note: This method is new in the .NET Framework version 2.0.

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 method is not CLS-compliant.  

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

[CLSCompliantAttribute(false)] 
[ComVisibleAttribute(false)] 
public override int GetBytes (
	char* chars,
	int charCount,
	byte* bytes,
	int byteCount
)
J# does not support APIs that consume or return unsafe types.
JScript does not support APIs that consume or return unsafe types.

Parameters

chars

A pointer to the first character to encode.

charCount

The number of characters to encode.

bytes

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

byteCount

The maximum number of bytes to write.

Return Value

The actual number of bytes written at the location indicated by the bytes parameter.
Exception typeCondition

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.

To calculate the exact array size that GetBytes requires to store the resulting bytes, use GetByteCount. To calculate the maximum array size, use GetMaxByteCount. The GetByteCount method generally allows you to allocate less memory, whereas the GetMaxByteCount method generally executes faster.

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

If the data to be converted is available only in sequential blocks (such as data read from a stream) or if the amount of data is so large that it needs to be divided into smaller blocks, use the Decoder or the Encoder object provided by the GetDecoder or the GetEncoder method, respectively.

Caution noteCaution

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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.