We recommend using Visual Studio 2017
This documentation is archived and is not being maintained.

ExtractHttpHeader Class

Used to extract an HTTP header value from the response and place the value of the header into the WebTestContext.


Namespace:  Microsoft.VisualStudio.TestTools.WebTesting.Rules
Assembly:  Microsoft.VisualStudio.QualityTools.WebTestFramework (in Microsoft.VisualStudio.QualityTools.WebTestFramework.dll)

public class ExtractHttpHeader : ExtractionRule

The ExtractHttpHeader type exposes the following members.

Public methodExtractHttpHeaderInitializes a new instance of the ExtractHttpHeader class.

Public propertyContextParameterNameGets or sets the context name of the extracted property. (Inherited from ExtractionRule.)
Public propertyHeaderGets or sets a value representing the name of the header whose value is to be extracted.
Public propertyRequiredGets or sets a value that indicates whether the request fails if the header does not exist.
Public propertyRuleDescription Obsolete. This method is no longer used. Use the DisplayNameAttribute on the class to set a description for this rule. (Inherited from ExtractionRule.)
Public propertyRuleName Obsolete. This method is no longer used. Use the DisplayNameAttribute on the class to set a display name for this rule. (Inherited from ExtractionRule.)

Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExtractExtracts the value of an HTTP header from the response and places the value and context parameter name into the WebTestContext. (Overrides ExtractionRule.Extract(Object, ExtractionEventArgs).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Consider the following HTTP headers:

Content-Length : 2036

Cache-Control : private

Content-Type : text/html; charset=utf-8

If Header is set to Content-Length, this rule will extract 2036 from the headers.

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