dotnet-api-docs/xml/System.Text/UTF7Encoding.xml at main · dotnet/dotnet-api-docs

History

1756 lines (1565 loc) · 130 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</TypeForwardingChain>

<Base>

<BaseTypeName>System.Text.Encoding</BaseTypeName>

</Base>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Serializable]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(true)]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Represents a UTF-7 encoding of Unicode characters.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

Encoding is the process of transforming a set of Unicode characters into a sequence of bytes. Decoding is the process of transforming a sequence of encoded bytes into a set of Unicode characters.

The UTF-7 encoding represents Unicode characters as sequences of 7-bit ASCII characters. This encoding supports certain protocols for which it is required, most often email or newsgroup protocols. Since UTF-7 is not particularly secure or robust, and most modern systems allow 8-bit encodings, UTF-8 should normally be preferred to UTF-7.

> [!NOTE]

> <xref:System.Text.UTF7Encoding> does not provide error detection. For security reasons, the application should use <xref:System.Text.UTF8Encoding>, <xref:System.Text.UnicodeEncoding>, or <xref:System.Text.UTF32Encoding> and enable error detection.

For more information about the UTFs and other encodings supported by <xref:System.Text>, see [Character Encoding in the .NET Framework](/dotnet/standard/base-types/character-encoding).

The <xref:System.Text.UTF7Encoding.GetByteCount%2A> method determines how many bytes result in encoding a set of Unicode characters, and the <xref:System.Text.UTF7Encoding.GetBytes%2A> method performs the actual encoding.

Likewise, the <xref:System.Text.UTF7Encoding.GetCharCount%2A> method determines how many characters result in decoding a sequence of bytes, and the <xref:System.Text.UTF7Encoding.GetChars%2A> and <xref:System.Text.UTF7Encoding.GetString%2A> methods perform the actual decoding.

<xref:System.Text.UTF7Encoding> corresponds to the Windows code page 65000.

> [!NOTE]

> The state of a UTF-7 encoded object is not preserved if the object is serialized and deserialized using different .NET Framework versions.

## Examples

The following code example demonstrates how to use a <xref:System.Text.UTF7Encoding> to encode a string of Unicode characters and store them in a byte array. Notice that when the byte array is decoded back to a string, no data is lost.

:::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/Overview/snippet.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Text/UTF7Encoding/Overview/snippet.vb" id="Snippet1":::

]]></format>

</remarks>

<related type="Article" href="/dotnet/standard/base-types/character-encoding">Understanding Encodings</related>

</Docs>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Text.UTF7Encoding" /> class.</summary>

</Docs>

</MemberGroup>

<MemberType>Constructor</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Obsolete("The UTF-7 encoding is insecure and should not be used. Consider using UTF-8 instead.", DiagnosticId="SYSLIB0001", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Text.UTF7Encoding" /> class.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

This constructor creates an instance that does not allow optional characters. Calling the <xref:System.Text.UTF7Encoding.%23ctor%2A> constructor is equivalent to calling the <xref:System.Text.UTF7Encoding.%23ctor%28System.Boolean%29?displayProperty=nameWithType> constructor that takes an `allowOptionals` parameter and specifying `false` for that parameter.

If an instance allows optional characters, Unicode code points are encoded with a corresponding optional character instead of a modified base 64 character. The optional characters are exclamation point ("!"), backward slash ("\\"), vertical line ("|"), double quote ("""), number sign ("#"), dollar sign ("$"), percent sign ("%"), ampersand ("&"), asterisk ("*"), semicolon (";"), left angle bracket ("\<"), right angle bracket (">"), left curly bracket ("{"), right curly bracket ("}"), left square bracket ("["), right square bracket ("]"), equal sign ("="), at sign ("@"), circumflex accent ("^"), underscore ("_"), and grave accent ("`").

> [!NOTE]

> <xref:System.Text.UTF7Encoding> does not provide error detection. For security reasons, your applications are recommended to use <xref:System.Text.UTF8Encoding>, <xref:System.Text.UnicodeEncoding>, or <xref:System.Text.UTF32Encoding> and enable error detection.

## Examples

The following code example demonstrates how to create a new <xref:System.Text.UTF7Encoding> instance and display the name of the encoding.

:::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/.ctor/ctor.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Text/UTF7Encoding/.ctor/ctor.vb" id="Snippet1":::

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Text.UTF7Encoding : bool -> System.Text.UTF7Encoding" Usage="new System.Text.UTF7Encoding allowOptionals" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

</Attribute>

</Attributes>

</Parameters>

<Docs>

<see langword="true" /> to specify that optional characters are allowed; otherwise, <see langword="false" />.</param>

<summary>Initializes a new instance of the <see cref="T:System.Text.UTF7Encoding" /> class. A parameter specifies whether to allow optional characters.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]

## Examples

The following code example demonstrates how to create a new <xref:System.Text.UTF7Encoding> instance that allows optional characters.

:::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/.ctor/ctor-boolean.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Text/UTF7Encoding/.ctor/ctor-boolean.vb" id="Snippet1":::

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="uTF7Encoding.Equals value" />

<MemberType>Method</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(false)]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.NotNullWhen(true)]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="value">An object to compare to the current <see cref="T:System.Text.UTF7Encoding" /> object.</param>

<summary>Gets a value indicating whether the specified object is equal to the current <see cref="T:System.Text.UTF7Encoding" /> object.</summary>

<see langword="true" /> if <paramref name="value" /> is a <see cref="T:System.Text.UTF7Encoding" /> object and is equal to the current <see cref="T:System.Text.UTF7Encoding" /> object; otherwise, <see langword="false" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

Two <xref:System.Text.UTF7Encoding> objects are equal if they both either allow or disallow optional characters, and if their underlying <xref:System.Text.Encoding.EncoderFallback%2A> and <xref:System.Text.Encoding.DecoderFallback%2A> properties are equal.

]]></format>

</remarks>

</Docs>

</Member>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Calculates the number of bytes produced by encoding a set of characters.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="override this.GetByteCount : string -> int" Usage="uTF7Encoding.GetByteCount s" />

<MemberType>Method</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(false)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="s">The <see cref="T:System.String" /> object containing the set of characters to encode.</param>

<summary>Calculates the number of bytes produced by encoding the characters in the specified <see cref="T:System.String" /> object.</summary>

<returns>The number of bytes produced by encoding the specified characters.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

To calculate the exact array size that <xref:System.Text.UTF7Encoding.GetBytes%2A> requires to store the resulting bytes, the application uses <xref:System.Text.UTF7Encoding.GetByteCount%2A>. To calculate the maximum array size, the application should use <xref:System.Text.UTF7Encoding.GetMaxByteCount%2A>. The <xref:System.Text.UTF7Encoding.GetByteCount%2A> method generally allows allocation of less memory, while the <xref:System.Text.UTF7Encoding.GetMaxByteCount%2A> method generally executes faster.

## Examples

The following code example demonstrates how to use the <xref:System.Text.UTF7Encoding.GetByteCount%2A> method to return the number of bytes required to encode a character array.

:::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetByteCount/getbytecount-char[]-int32-int32.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Text/UTF7Encoding/GetByteCount/getbytecount-char[]-int32-int32.vb" id="Snippet1":::

]]></format>

</remarks>

<exception cref="T:System.ArgumentOutOfRangeException">The resulting number of bytes is greater than the maximum number that can be returned as an int.</exception>

<exception cref="T:System.Text.EncoderFallbackException">A fallback occurred (for more information, see <see href="https://learn.microsoft.com/dotnet/standard/base-types/character-encoding">Character Encoding in .NET</see>).

-and-

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.GetByteCount : nativeptr<char> * int -> int" Usage="uTF7Encoding.GetByteCount (chars, count)" />

<MemberType>Method</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.CLSCompliant(false)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(false)]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="chars">A pointer to the first character to encode.</param>

<param name="count">The number of characters to encode.</param>

<summary>Calculates the number of bytes produced by encoding a set of characters starting at the specified character pointer.</summary>

<returns>The number of bytes produced by encoding the specified characters.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

]]></format>

</remarks>

<paramref name="chars" /> is <see langword="null" /> (<see langword="Nothing" /> in Visual Basic .NET).</exception>

<paramref name="count" /> is less than zero.

-or-

The resulting number of bytes is greater than the maximum number that can be returned as an int.</exception>

-and-

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.GetByteCount : char[] * int * int -> int" Usage="uTF7Encoding.GetByteCount (chars, index, count)" />

<MemberSignature Language="C++ CLI" Value="public:
 override int GetByteCount(cli::array <char> ^ chars, int index, int count);" />

<MemberType>Method</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="chars">The character array containing the set of characters to encode.</param>

<param name="index">The index of the first character to encode.</param>

<param name="count">The number of characters to encode.</param>

<summary>Calculates the number of bytes produced by encoding a set of characters from the specified character array.</summary>

<returns>The number of bytes produced by encoding the specified characters.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

To calculate the exact array size required by <xref:System.Text.UTF7Encoding.GetBytes%2A> to store the resulting bytes, the application uses <xref:System.Text.UTF7Encoding.GetByteCount%2A>. To calculate the maximum array size, the application should use <xref:System.Text.UTF7Encoding.GetMaxByteCount%2A>. The <xref:System.Text.UTF7Encoding.GetByteCount%2A> method generally allows allocation of less memory, while the <xref:System.Text.UTF7Encoding.GetMaxByteCount%2A> method generally executes faster.

## Examples

The following code example demonstrates how to use the <xref:System.Text.UTF7Encoding.GetByteCount%2A> method to return the number of bytes required to encode an array of Unicode characters.

:::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetByteCount/getbytecount-char[]-int32-int32.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Text/UTF7Encoding/GetByteCount/getbytecount-char[]-int32-int32.vb" id="Snippet1":::

]]></format>

</remarks>

<paramref name="index" /> or <paramref name="count" /> is less than zero.

-or-

<paramref name="index" /> and <paramref name="count" /> do not denote a valid range in <paramref name="chars" />.

-or-

The resulting number of bytes is greater than the maximum number that can be returned as an int.</exception>

-and-

</Docs>

</Member>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Encodes a set of characters into a sequence of bytes.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="override this.GetBytes : nativeptr<char> * int * nativeptr<byte> * int -> int" Usage="uTF7Encoding.GetBytes (chars, charCount, bytes, byteCount)" />

<MemberType>Method</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.CLSCompliant(false)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(false)]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="chars">A pointer to the first character to encode.</param>

<param name="charCount">The number of characters to encode.</param>

<param name="bytes">A pointer to the location at which to start writing the resulting sequence of bytes.</param>

<param name="byteCount">The maximum number of bytes to write.</param>

<summary>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.</summary>

<returns>The actual number of bytes written at the location indicated by <paramref name="bytes" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

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 <xref:System.Text.Decoder> or the <xref:System.Text.Encoder> provided by the <xref:System.Text.UTF7Encoding.GetDecoder%2A> method or the <xref:System.Text.UTF7Encoding.GetEncoder%2A> method, respectively.

> [!NOTE]

> <xref:System.Text.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 <xref:System.Text.UTF8Encoding>, <xref:System.Text.UnicodeEncoding>, or <xref:System.Text.UTF32Encoding> and enable error detection.

]]></format>

</remarks>

<paramref name="chars" /> is <see langword="null" /> (<see langword="Nothing" />).

-or-

<paramref name="byteCount" /> is less than the resulting number of bytes.</exception>

<exception cref="T:System.Text.EncoderFallbackException">A fallback occurred (see <see href="https://learn.microsoft.com/dotnet/standard/base-types/character-encoding">Character Encoding in .NET</see> for fuller explanation).

-and-

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.GetBytes : char[] * int * int * byte[] * int -> int" Usage="uTF7Encoding.GetBytes (chars, charIndex, charCount, bytes, byteIndex)" />

<MemberSignature Language="C++ CLI" Value="public:
 override int GetBytes(cli::array <char> ^ chars, int charIndex, int charCount, cli::array <System::Byte> ^ bytes, int byteIndex);" />

<MemberType>Method</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="chars">The character array containing the set of characters to encode.</param>

<param name="charIndex">The index of the first character to encode.</param>

<param name="charCount">The number of characters to encode.</param>

<param name="bytes">The byte array to contain the resulting sequence of bytes.</param>

<param name="byteIndex">The index at which to start writing the resulting sequence of bytes.</param>

<summary>Encodes a set of characters from the specified character array into the specified byte array.</summary>

<returns>The actual number of bytes written into <paramref name="bytes" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]

## Examples

The following code example demonstrates how to use the <xref:System.Text.UTF7Encoding.GetBytes%2A> method to encode a range of characters from a <xref:System.String> and store the encoded bytes in a range of elements in a byte array.

:::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetBytes/getbytes-char[]-int32-int32-byte[]-int32.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Text/UTF7Encoding/GetBytes/getbytes-char[]-int32-int32-byte[]-int32.vb" id="Snippet1":::

]]></format>

</remarks>

<paramref name="chars" /> is <see langword="null" /> (<see langword="Nothing" />).

-or-

<paramref name="charIndex" /> or <paramref name="charCount" /> or <paramref name="byteIndex" /> is less than zero.

-or-

<paramref name="charIndex" /> and <paramref name="charCount" /> do not denote a valid range in <paramref name="chars" />.

-or-

<paramref name="byteIndex" /> is not a valid index in <paramref name="bytes" />.</exception>

<paramref name="bytes" /> does not have enough capacity from <paramref name="byteIndex" /> to the end of the array to accommodate the resulting bytes.</exception>

-and-

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.GetBytes : string * int * int * byte[] * int -> int" Usage="uTF7Encoding.GetBytes (s, charIndex, charCount, bytes, byteIndex)" />

<MemberSignature Language="C++ CLI" Value="public:
 override int GetBytes(System::String ^ s, int charIndex, int charCount, cli::array <System::Byte> ^ bytes, int byteIndex);" />

<MemberType>Method</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(false)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="s">The <see cref="T:System.String" /> containing the set of characters to encode.</param>

<param name="charIndex">The index of the first character to encode.</param>

<param name="charCount">The number of characters to encode.</param>

<param name="bytes">The byte array to contain the resulting sequence of bytes.</param>

<param name="byteIndex">The index at which to start writing the resulting sequence of bytes.</param>

<summary>Encodes a set of characters from the specified <see cref="T:System.String" /> into the specified byte array.</summary>

<returns>The actual number of bytes written into <paramref name="bytes" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]

## Examples

The following code example demonstrates how to use the <xref:System.Text.UTF7Encoding.GetBytes%2A> method to encode a range of elements from a Unicode character array, and store the encoded bytes in a range of elements in a byte array.

:::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetBytes/getbytes-char[]-int32-int32-byte[]-int32.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Text/UTF7Encoding/GetBytes/getbytes-char[]-int32-int32-byte[]-int32.vb" id="Snippet1":::

]]></format>

</remarks>

<paramref name="s" /> is <see langword="null" /> (<see langword="Nothing" />).

-or-

<paramref name="charIndex" /> or <paramref name="charCount" /> or <paramref name="byteIndex" /> is less than zero.

-or-

<paramref name="charIndex" /> and <paramref name="charCount" /> do not denote a valid range in <paramref name="s" />.

-or-

<paramref name="byteIndex" /> is not a valid index in <paramref name="bytes" />.</exception>

<paramref name="bytes" /> does not have enough capacity from <paramref name="byteIndex" /> to the end of the array to accommodate the resulting bytes.</exception>

-and-

</Docs>

</Member>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Calculates the number of characters produced by decoding a sequence of bytes.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="override this.GetCharCount : nativeptr<byte> * int -> int" Usage="uTF7Encoding.GetCharCount (bytes, count)" />

<MemberType>Method</MemberType>

<AssemblyName>System.Text.Encoding.Extensions</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.CLSCompliant(false)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(false)]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="bytes">A pointer to the first byte to decode.</param>

<param name="count">The number of bytes to decode.</param>

<summary>Calculates the number of characters produced by decoding a sequence of bytes starting at the specified byte pointer.</summary>

<returns>The number of characters produced by decoding the specified sequence of bytes.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

To calculate the exact array size required by <xref:System.Text.UTF7Encoding.GetChars%2A> to store the resulting characters, use <xref:System.Text.UTF7Encoding.GetCharCount%2A>. To calculate the maximum array size, the application should use <xref:System.Text.UTF7Encoding.GetMaxCharCount%2A>. The <xref:System.Text.UTF7Encoding.GetCharCount%2A> method generally allows allocation of less memory, while the <xref:System.Text.UTF7Encoding.GetMaxCharCount%2A> method generally executes faster.

]]></format>

</remarks>

<paramref name="count" /> is less than zero.

-or-

The resulting number of characters is greater than the maximum number that can be returned as an int.</exception>

<exception cref="T:System.Text.DecoderFallbackException">A fallback occurred (for more information, see <see href="https://learn.microsoft.com/dotnet/standard/base-types/character-encoding">Character Encoding in .NET</see>).

-and-

</Docs>

</Member>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

UTF7Encoding.xml

Latest commit

History

UTF7Encoding.xml

File metadata and controls