WebHeaderCollection

WebHeaderCollection class

Represents the collection of the protocol headers. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

class WebHeaderCollection : public System::Object

Methods

MethodDescription
void Add(String, String)Adds the specified pair of the header name and the header value to the collection.
void Add(HttpResponseHeader, String)Adds the specified pair of the header and the header value to the collection.
void Add(HttpRequestHeader, String)Adds the specified pair of the header and the header value to the collection.
System::ArrayPtr<String> AllKeys()Returns a collection of header names that are stored in the collection.
virtual bool Equals(ptr)Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares value type objects in C# style.
static bool Equals(float const&, float const&)Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
static bool Equals(double const&, double const&)Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
virtual bool FastCast(const Details::FastRttiBase&, void **) constFor internal purposes only.
int32_t get_Count() constReturns a number of elements in the collection.
System::ArrayPtr<String> get_Keys()Returns a collection of header names that are stored in the collection.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
String GetKey(int)Returns a key at the specified index.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
System::ArrayPtr<System::String> GetValues(String)Returns the collection of the header values.
String idx_get(HttpRequestHeader)Gets the header value using the specified request’s header.
String idx_get(HttpResponseHeader)Gets the header value using the specified response’s header.
String idx_get(String)Gets the header value using the specified header name.
void idx_set(HttpRequestHeader, String)Sets the header value of the specified header.
void idx_set(HttpResponseHeader, String)Sets the header value using the specified response’s header.
void idx_set(String, String)Sets the header value using the specified header name.
virtual bool Is(const TypeInfo&) constCheck if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
static bool IsRestricted(const String&)Tests whether the specified HTTP header can be set for the request.
void Lock()Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() constAnalog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()Creates object. Initializes all internal data structures.
Object(Object const&)Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)Specialization of Object::ReferenceEquals for case of strings.
void Remove(String)Removes the header by the specified header name.
void Remove(HttpResponseHeader)Removes the specified response’s header.
void Remove(HttpRequestHeader)Removes the specified request’s header.
int RemovedSharedRefs(int)Decreases shared reference count by specified value.
void Set(String, String)Sets the value of the specified header.
virtual void SetTemplateWeakPtr(uint32_t)Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() constGets current value of shared reference counter.
Object * SharedRefAdded()Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
String ToString() const overrideAnalog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()Implements C# typeof(System.Object) construct.
void Unlock()Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
WebHeaderCollection()Constructs a new instance.
virtual ~Object()Destroys object. Frees all internal data structures.

See Also