HeaderDictionary Class

 

Represents a wrapper for owin.RequestHeaders and owin.ResponseHeaders.

Namespace:   Microsoft.Owin
Assembly:  Microsoft.Owin (in Microsoft.Owin.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Owin.HeaderDictionary

Syntax

public class HeaderDictionary : IHeaderDictionary, IReadableStringCollection, 
    IDictionary<string, string[]>, ICollection<KeyValuePair<string, string[]>>, 
    IEnumerable<KeyValuePair<string, string[]>>, IEnumerable

public ref class HeaderDictionary : IHeaderDictionary, IReadableStringCollection, 
    IDictionary<String^, array<String^>^>, ICollection<KeyValuePair<String^, array<String^>^>>, 
    IEnumerable<KeyValuePair<String^, array<String^>^>>, IEnumerable

type HeaderDictionary = 
    class
        interface IHeaderDictionary
        interface IReadableStringCollection
        interface IDictionary<string, string[]>
        interface ICollection<KeyValuePair<string, string[]>>
        interface IEnumerable<KeyValuePair<string, string[]>>
        interface IEnumerable
    end

Public Class HeaderDictionary
    Implements IHeaderDictionary, IReadableStringCollection, IDictionary(Of String, String()),
    ICollection(Of KeyValuePair(Of String, String())), IEnumerable(Of KeyValuePair(Of String, String())),
    IEnumerable

Constructors

	Name	Description
	HeaderDictionary(IDictionary<String, String[]>)	Initializes a new instance of the HeaderDictionary class.

Properties

	Name	Description
	Count	Gets the number of elements contained in the HeaderDictionary ;.
	IsReadOnly	Gets a value that indicates whether the HeaderDictionary is in read-only mode.
	Item[String]	Get or sets the associated value from the collection as a single string.
	Keys	Gets an ICollection that contains the keys in the HeaderDictionary ;.
	Values	Gets the attribute value.

Methods

	Name	Description
	Add(KeyValuePair<String, String[]>)	Adds a new list of items to the collection.
	Add(String, String[])	Adds the given header and values to the collection.
	Append(String, String)	Add a new value. Appends to the header if already present
	AppendCommaSeparatedValues(String, String[])	Quotes any values containing comas, and then coma joins all of the values with any existing values.
	AppendValues(String, String[])	Add new values. Each item remains a separate array entry.
	Clear()	Clears the entire list of objects.
	Contains(KeyValuePair<String, String[]>)	Returns a value indicating whether the specified object occurs within this collection.
	ContainsKey(String)	Determines whether the HeaderDictionary contains a specific key.
	CopyTo(KeyValuePair<String, String[]>[], Int32)	Copies the HeaderDictionary elements to a one-dimensional Array instance at the specified index.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	Get(String)	Get the associated value from the collection as a single string.
	GetCommaSeparatedValues(String)	Get the associated values from the collection separated into individual values. Quoted values will not be split, and the quotes will be removed.
	GetEnumerator()	Returns an enumerator that iterates through a collection.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	GetValues(String)	Get the associated values from the collection without modification.
	MemberwiseClone()	(Inherited from Object.)
	Remove(KeyValuePair<String, String[]>)	Removes the given item from the the collection.
	Remove(String)	Removes the given header from the collection.
	Set(String, String)	Sets a specific header value.
	SetCommaSeparatedValues(String, String[])	Quotes any values containing comas, and then coma joins all of the values.
	SetValues(String, String[])	Sets the specified header values without modification.
	ToString()	(Inherited from Object.)
	TryGetValue(String, String[])	Retrieves a value from the dictionary.

Explicit Interface Implementations

	Name	Description
	IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Owin Namespace

Return to top