FormReader Class

Definition

Namespace:

Microsoft.AspNetCore.WebUtilities

Assembly:

Microsoft.AspNetCore.WebUtilities.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Used to read an 'application/x-www-form-urlencoded' form.

public ref class FormReader : IDisposable

public class FormReader : IDisposable

type FormReader = class
    interface IDisposable

Public Class FormReader
Implements IDisposable

Inheritance

Object

FormReader

Implements

IDisposable

Constructors

FormReader(Stream)	Initializes a new instance of FormReader.
FormReader(Stream, Encoding)	Initializes a new instance of FormReader.
FormReader(Stream, Encoding, ArrayPool<Char>)	Initializes a new instance of FormReader.
FormReader(String)	Initializes a new instance of FormReader.
FormReader(String, ArrayPool<Char>)	Initializes a new instance of FormReader.

Fields

DefaultKeyLengthLimit	Gets the default value for KeyLengthLimit. Defaults to 2,048 bytes, which is approximately 2KB.
DefaultValueCountLimit	Gets the default value for ValueCountLimit. Defaults to 1024.
DefaultValueLengthLimit	Gets the default value for ValueLengthLimit. Defaults to 4,194,304 bytes, which is approximately 4MB.

Properties

KeyLengthLimit	The limit on the length of form keys.
ValueCountLimit	The limit on the number of form values to allow in ReadForm or ReadFormAsync.
ValueLengthLimit	The limit on the length of form values.

Methods

Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
ReadForm()	Parses text from an HTTP form body.
ReadFormAsync(CancellationToken)	Parses an HTTP form body.
ReadNextPair()	Reads the next key value pair from the form. For unbuffered data use the async overload instead.
ReadNextPairAsync(CancellationToken)	Asynchronously reads the next key value pair from the form.