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. More...

#include <web_header_collection.h>

Inherits System::Object.

Public Member Functions
void	Add (String header, String value)
	Adds the specified pair of the header name and the header value to the collection. More...

void	Add (HttpResponseHeader header, String value)
	Adds the specified pair of the header and the header value to the collection. More...

void	Add (HttpRequestHeader header, String value)
	Adds the specified pair of the header and the header value to the collection. More...

String	idx_get (HttpRequestHeader header)
	Gets the header value using the specified request's header. More...

void	idx_set (HttpRequestHeader header, String value)
	Sets the header value of the specified header. More...

String	idx_get (HttpResponseHeader header)
	Gets the header value using the specified response's header. More...

void	idx_set (HttpResponseHeader header, String value)
	Sets the header value using the specified response's header. More...

String	idx_get (String name)
	Gets the header value using the specified header name. More...

void	idx_set (String name, String value)
	Sets the header value using the specified header name. More...

void	Remove (String name)
	Removes the header by the specified header name. More...

void	Remove (HttpResponseHeader header)
	Removes the specified response's header. More...

void	Remove (HttpRequestHeader header)
	Removes the specified request's header. More...

String	ToString () const override
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

	WebHeaderCollection ()
	Constructs a new instance. More...

int32_t	get_Count () const
	Returns a number of elements in the collection. More...

System::ArrayPtr< String >	AllKeys ()
	Returns a collection of header names that are stored in the collection. More...

System::ArrayPtr< String >	get_Keys ()
	Returns a collection of header names that are stored in the collection. More...

String	GetKey (int index)
	Returns a key at the specified index. More...

System::ArrayPtr< System::String >	GetValues (String header)
	Returns the collection of the header values. More...

void	Set (String name, String value)
	Sets the value of the specified header. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Static Public Member Functions
static bool	IsRestricted (const String &headerName)
	Tests whether the specified HTTP header can be set for the request. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	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. More...

template<>
bool	Equals (double const &objA, double const &objB)
	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. More...

Protected Member Functions
	~WebHeaderCollection () override
	Destructs the current instance. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Detailed Description

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.

Constructor & Destructor Documentation

◆ WebHeaderCollection()

System::Net::WebHeaderCollection::WebHeaderCollection ( )

Constructs a new instance.

◆ ~WebHeaderCollection()

System::Net::WebHeaderCollection::~WebHeaderCollection ( )

overrideprotected

Destructs the current instance.

Member Function Documentation

◆ Add() [1/3]

void System::Net::WebHeaderCollection::Add	(	HttpRequestHeader	header,
		String	value
	)

Adds the specified pair of the header and the header value to the collection.

Parameters

header	The header.
value	The header value.

◆ Add() [2/3]

void System::Net::WebHeaderCollection::Add	(	HttpResponseHeader	header,
		String	value
	)

Adds the specified pair of the header and the header value to the collection.

Parameters

header	The header.
value	The header value.

◆ Add() [3/3]

void System::Net::WebHeaderCollection::Add	(	String	header,
		String	value
	)

Adds the specified pair of the header name and the header value to the collection.

Parameters

header	The header name.
value	The header value.

◆ AllKeys()

System::ArrayPtr< String > System::Net::WebHeaderCollection::AllKeys ( )

Returns a collection of header names that are stored in the collection.

Returns: A collection of header names that are stored in the collection.

◆ get_Count()

int32_t System::Net::WebHeaderCollection::get_Count ( ) const

Returns a number of elements in the collection.

Returns: A number of elements in the collection.

◆ get_Keys()

System::ArrayPtr< String > System::Net::WebHeaderCollection::get_Keys ( )

Returns a collection of header names that are stored in the collection.

Returns: A collection of header names that are stored in the collection.

◆ GetKey()

String System::Net::WebHeaderCollection::GetKey ( int index )

Returns a key at the specified index.

Parameters

index The index.

Returns: A key at the specified index.

◆ GetValues()

System::ArrayPtr< System::String > System::Net::WebHeaderCollection::GetValues ( String header )

Returns the collection of the header values.

Parameters

header The header for which values must be returned.

Returns: The collection of the header values.

◆ idx_get() [1/3]

String System::Net::WebHeaderCollection::idx_get ( HttpRequestHeader header )

Gets the header value using the specified request's header.

Parameters

header The header.

Returns: The header value using the specified header.

◆ idx_get() [2/3]

String System::Net::WebHeaderCollection::idx_get ( HttpResponseHeader header )

Gets the header value using the specified response's header.

Parameters

header The header.

Returns: The header value using the specified header.

◆ idx_get() [3/3]

String System::Net::WebHeaderCollection::idx_get ( String name )

Gets the header value using the specified header name.

Parameters

name	The header name.

Returns: The header value using the specified header name.

◆ idx_set() [1/3]

void System::Net::WebHeaderCollection::idx_set	(	HttpRequestHeader	header,
		String	value
	)

Sets the header value of the specified header.

Parameters

header	The header.
value	The header value to set.

◆ idx_set() [2/3]

void System::Net::WebHeaderCollection::idx_set	(	HttpResponseHeader	header,
		String	value
	)

Sets the header value using the specified response's header.

Parameters

header	The header.
value	The header value to set.

◆ idx_set() [3/3]

void System::Net::WebHeaderCollection::idx_set	(	String	name,
		String	value
	)

Sets the header value using the specified header name.

Parameters

name	The header name.
value	The header value to set.

◆ IsRestricted()

static bool System::Net::WebHeaderCollection::IsRestricted ( const String & headerName )

static

Tests whether the specified HTTP header can be set for the request.

Parameters

headerName The header name to test.

Returns: true if the header is restricted; otherwise false.

◆ Remove() [1/3]

void System::Net::WebHeaderCollection::Remove ( HttpRequestHeader header )

Removes the specified request's header.

Parameters

header The header to remove.

◆ Remove() [2/3]

void System::Net::WebHeaderCollection::Remove ( HttpResponseHeader header )

Removes the specified response's header.

Parameters

header The header to remove.

◆ Remove() [3/3]

void System::Net::WebHeaderCollection::Remove ( String name )

Removes the header by the specified header name.

Parameters

name	The header name.

◆ Set()

void System::Net::WebHeaderCollection::Set	(	String	name,
		String	value
	)

Sets the value of the specified header.

Parameters

name	The header name.
value	The value to set.

◆ ToString()

String System::Net::WebHeaderCollection::ToString ( ) const

overridevirtual

Analog of C# Object.ToString() method. Enables converting custom objects to string.

Returns: String representation as provided by final class.

Reimplemented from System::Object.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WebHeaderCollection()

◆ ~WebHeaderCollection()

Member Function Documentation

◆ Add() [1/3]

◆ Add() [2/3]

◆ Add() [3/3]

◆ AllKeys()

◆ get_Count()

◆ get_Keys()

◆ GetKey()

◆ GetValues()

◆ idx_get() [1/3]

◆ idx_get() [2/3]

◆ idx_get() [3/3]

◆ idx_set() [1/3]

◆ idx_set() [2/3]

◆ idx_set() [3/3]

◆ IsRestricted()

◆ Remove() [1/3]

◆ Remove() [2/3]

◆ Remove() [3/3]

◆ Set()

◆ ToString()