GetBytes Method (Char*, Int32, Byte*, Int32)
Collapse the table of content
Expand the table of content

UTF7Encoding.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)

[SecurityCriticalAttribute]
[CLSCompliantAttribute(false)]
[ComVisibleAttribute(false)]
public override unsafe int GetBytes(
	char* chars,
	int charCount,
	byte* bytes,
	int byteCount
)

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 bytes.

Exception Condition
ArgumentNullException

chars is null (Nothing).

-or-

bytes is null (Nothing).

ArgumentOutOfRangeException

charCount or byteCount is less than zero.

ArgumentException

byteCount is less than the resulting number of bytes.

EncoderFallbackException

A fallback occurred (see Character Encoding in the .NET Framework for fuller 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.

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 should use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.

System_CAPS_noteNote

UTF7Encoding does not provide error detection. Invalid characters are encoded as a modified base 64 character. For security reasons, your applications are recommended to use UTF8Encoding, UnicodeEncoding, or UTF32Encoding and enable error detection.

SecurityCriticalAttribute

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

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft