Asposecpplib

Represents an http web-proxy server. 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...

Inherits System::Net::IWebProxy.

Public Member Functions

System::SharedPtr< Uriget_Address ()
 Gets the address of the current proxy server. More...
 
void set_Address (System::SharedPtr< Uri > value)
 Sets the address of the current proxy server. More...
 
bool get_BypassProxyOnLocal ()
 Gets a value that indicates if the proxy server must be used for local addresses. More...
 
void set_BypassProxyOnLocal (bool value)
 Sets a value that indicates if the proxy server must be used for local addresses. More...
 
System::ArrayPtr< Stringget_BypassList ()
 Gets the list of addresses that do not use the proxy server. More...
 
void set_BypassList (System::ArrayPtr< String > value)
 Sets the list of addresses that do not use the proxy server. More...
 
System::SharedPtr< ICredentialsget_Credentials ()
 Gets the credentials that are sent to the proxy server for authentication. More...
 
void set_Credentials (System::SharedPtr< ICredentials > value)
 Sets the credentials that are sent to the proxy server for authentication. More...
 
bool get_UseDefaultCredentials ()
 Gets a value that indicates if the default credentials must be sent with requests. More...
 
void set_UseDefaultCredentials (bool value)
 Sets a value that indicates if the default credentials must be sent with requests. More...
 
 WebProxy ()
 Constructs a new instance. More...
 
 WebProxy (System::SharedPtr< Uri > Address)
 Constructs a new instance. More...
 
 WebProxy (System::SharedPtr< Uri > Address, bool BypassOnLocal)
 Constructs a new instance. More...
 
 WebProxy (System::SharedPtr< Uri > Address, bool BypassOnLocal, System::ArrayPtr< String > BypassList)
 Constructs a new instance. More...
 
 WebProxy (System::SharedPtr< Uri > Address, bool BypassOnLocal, System::ArrayPtr< String > BypassList, System::SharedPtr< ICredentials > Credentials)
 Constructs a new instance. More...
 
 WebProxy (String Host, int32_t Port)
 Constructs a new instance. More...
 
 WebProxy (String Address)
 Constructs a new instance. More...
 
 WebProxy (String Address, bool BypassOnLocal)
 Constructs a new instance. More...
 
 WebProxy (String Address, bool BypassOnLocal, System::ArrayPtr< String > BypassList)
 Constructs a new instance. More...
 
 WebProxy (String Address, bool BypassOnLocal, System::ArrayPtr< String > BypassList, System::SharedPtr< ICredentials > Credentials)
 Constructs a new instance. More...
 
System::SharedPtr< UriGetProxy (System::SharedPtr< Uri > destination)
 Returns the proxied URI for a web request. More...
 
bool IsBypassed (System::SharedPtr< Uri > host)
 Checks if the proxy server is not used for the specified URI. 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 TypeInfoGetType () 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 System::SharedPtr< WebProxyGetDefaultProxy ()
 Returns the proxy that uses the non-dynamic settings of the Internet Explorer. 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 TypeInfoType ()
 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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

Represents an http web-proxy server. 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

◆ WebProxy() [1/10]

System::Net::WebProxy::WebProxy ( )

Constructs a new instance.

◆ WebProxy() [2/10]

System::Net::WebProxy::WebProxy ( System::SharedPtr< Uri Address)

Constructs a new instance.

Parameters
AddressThe proxy server address.

◆ WebProxy() [3/10]

System::Net::WebProxy::WebProxy ( System::SharedPtr< Uri Address,
bool  BypassOnLocal 
)

Constructs a new instance.

Parameters
AddressThe proxy server address.
BypassOnLocalA value that indicates if the proxy server must be used for local addresses.

◆ WebProxy() [4/10]

System::Net::WebProxy::WebProxy ( System::SharedPtr< Uri Address,
bool  BypassOnLocal,
System::ArrayPtr< String BypassList 
)

Constructs a new instance.

Parameters
AddressThe proxy server address.
BypassOnLocalA value that indicates if the proxy server must be used for local addresses.
BypassListThe list of addresses that do not use the proxy server.

◆ WebProxy() [5/10]

System::Net::WebProxy::WebProxy ( System::SharedPtr< Uri Address,
bool  BypassOnLocal,
System::ArrayPtr< String BypassList,
System::SharedPtr< ICredentials Credentials 
)

Constructs a new instance.

Parameters
AddressThe proxy server address.
BypassOnLocalA value that indicates if the proxy server must be used for local addresses.
BypassListThe list of addresses that do not use the proxy server.
CredentialsThe credentials that are sent to the proxy server for authentication.

◆ WebProxy() [6/10]

System::Net::WebProxy::WebProxy ( String  Host,
int32_t  Port 
)

Constructs a new instance.

Parameters
HostThe host name.
PortThe port number.

◆ WebProxy() [7/10]

System::Net::WebProxy::WebProxy ( String  Address)

Constructs a new instance.

Parameters
AddressThe proxy server address.

◆ WebProxy() [8/10]

System::Net::WebProxy::WebProxy ( String  Address,
bool  BypassOnLocal 
)

Constructs a new instance.

Parameters
AddressThe proxy server address.
BypassOnLocalA value that indicates if the proxy server must be used for local addresses.

◆ WebProxy() [9/10]

System::Net::WebProxy::WebProxy ( String  Address,
bool  BypassOnLocal,
System::ArrayPtr< String BypassList 
)

Constructs a new instance.

Parameters
AddressThe proxy server address.
BypassOnLocalA value that indicates if the proxy server must be used for local addresses.
BypassListThe list of addresses that do not use the proxy server.

◆ WebProxy() [10/10]

System::Net::WebProxy::WebProxy ( String  Address,
bool  BypassOnLocal,
System::ArrayPtr< String BypassList,
System::SharedPtr< ICredentials Credentials 
)

Constructs a new instance.

Parameters
AddressThe proxy server address.
BypassOnLocalA value that indicates if the proxy server must be used for local addresses.
BypassListThe list of addresses that do not use the proxy server.
CredentialsThe credentials that are sent to the proxy server for authentication.

Member Function Documentation

◆ get_Address()

System::SharedPtr<Uri> System::Net::WebProxy::get_Address ( )

Gets the address of the current proxy server.

Returns
The address of the current proxy server.

◆ get_BypassList()

System::ArrayPtr<String> System::Net::WebProxy::get_BypassList ( )

Gets the list of addresses that do not use the proxy server.

Returns
The list of addresses that do not use the proxy server.

◆ get_BypassProxyOnLocal()

bool System::Net::WebProxy::get_BypassProxyOnLocal ( )

Gets a value that indicates if the proxy server must be used for local addresses.

Returns
A value that indicates if the proxy server must be used for local addresses.

◆ get_Credentials()

System::SharedPtr<ICredentials> System::Net::WebProxy::get_Credentials ( )
virtual

Gets the credentials that are sent to the proxy server for authentication.

Returns
The credentials that are sent to the proxy server for authentication.

Implements System::Net::IWebProxy.

◆ get_UseDefaultCredentials()

bool System::Net::WebProxy::get_UseDefaultCredentials ( )

Gets a value that indicates if the default credentials must be sent with requests.

Returns
A value that indicates if the default credentials must be sent with requests.

◆ GetDefaultProxy()

static System::SharedPtr<WebProxy> System::Net::WebProxy::GetDefaultProxy ( )
static

Returns the proxy that uses the non-dynamic settings of the Internet Explorer.

Returns
The proxy that uses the non-dynamic settings of the Internet Explorer.

◆ GetProxy()

System::SharedPtr<Uri> System::Net::WebProxy::GetProxy ( System::SharedPtr< Uri destination)
virtual

Returns the proxied URI for a web request.

Parameters
destinationThe resource's URI.
Returns
The proxied URI.

Implements System::Net::IWebProxy.

◆ IsBypassed()

bool System::Net::WebProxy::IsBypassed ( System::SharedPtr< Uri host)
virtual

Checks if the proxy server is not used for the specified URI.

Parameters
hostThe URI to check.
Returns
True when the proxy server is not used for the specified URI, otherwise false.

Implements System::Net::IWebProxy.

◆ set_Address()

void System::Net::WebProxy::set_Address ( System::SharedPtr< Uri value)

Sets the address of the current proxy server.

Parameters
valueThe address to set.

◆ set_BypassList()

void System::Net::WebProxy::set_BypassList ( System::ArrayPtr< String value)

Sets the list of addresses that do not use the proxy server.

Parameters
valueThe list to set.

◆ set_BypassProxyOnLocal()

void System::Net::WebProxy::set_BypassProxyOnLocal ( bool  value)

Sets a value that indicates if the proxy server must be used for local addresses.

Parameters
valueA value to set.

◆ set_Credentials()

void System::Net::WebProxy::set_Credentials ( System::SharedPtr< ICredentials value)
virtual

Sets the credentials that are sent to the proxy server for authentication.

Parameters
valueThe credentials to set.

Implements System::Net::IWebProxy.

◆ set_UseDefaultCredentials()

void System::Net::WebProxy::set_UseDefaultCredentials ( bool  value)

Sets a value that indicates if the default credentials must be sent with requests.

Parameters
valueA vault to set.