System::Xml::XmlResolver Class Referenceabstract

Resolves external XML resources specified by URI. 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::Object.

Inherited by System::Xml::XmlUrlResolver.

Public Types

typedef SharedPtr< XmlResolverPtr
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

virtual void set_Credentials (SharedPtr< System::Net::ICredentials > value)
 Sets the credentials that are used to authenticate web requests. More...
 
virtual SharedPtr< ObjectGetEntity (SharedPtr< Uri > absoluteUri, String role, const TypeInfo &ofObjectToReturn)=0
 Returns an object that contains a resource specified by a URI. More...
 
virtual SharedPtr< UriResolveUri (SharedPtr< Uri > baseUri, String relativeUri)
 Creates an absolute URI from the specified base and relative URIs. More...
 
virtual bool SupportsType (SharedPtr< Uri > absoluteUri, const TypeInfo &type)
 Determines if the XmlResolver::GetEntity() can return objects of the specified type. 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 Protected Member Functions

static String EscapeRelativeUriBody (const String &src)
 Escapes the specified string. More...
 
static String UnescapeRelativeUriBody (const String &src)
 Unescapes the specified string. More...
 

Additional Inherited Members

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

Detailed Description

Resolves external XML resources specified by URI. 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.

Member Typedef Documentation

◆ Ptr

An alias for shared pointer to an instance of this class.

Member Function Documentation

◆ EscapeRelativeUriBody()

static String System::Xml::XmlResolver::EscapeRelativeUriBody ( const String src)
staticprotected

Escapes the specified string.

Parameters
srcThe string to escape
Returns
The escaped string

◆ GetEntity()

virtual SharedPtr<Object> System::Xml::XmlResolver::GetEntity ( SharedPtr< Uri absoluteUri,
String  role,
const TypeInfo ofObjectToReturn 
)
pure virtual

Returns an object that contains a resource specified by a URI.

Parameters
absoluteUriThe URI
roleNOT USED
ofObjectToReturnThe type of object to return; must always be System.IO.Stream
Returns
A stream object representing the specified resource

Implemented in System::Xml::XmlUrlResolver.

◆ ResolveUri()

virtual SharedPtr<Uri> System::Xml::XmlResolver::ResolveUri ( SharedPtr< Uri baseUri,
String  relativeUri 
)
virtual

Creates an absolute URI from the specified base and relative URIs.

Parameters
baseUriA base URI
relativeUriA relative URI
Returns
An absolute URI

◆ set_Credentials()

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

Sets the credentials that are used to authenticate web requests.

Parameters
valueThe ICredentials object representing the credentials to set

◆ SupportsType()

virtual bool System::Xml::XmlResolver::SupportsType ( SharedPtr< Uri absoluteUri,
const TypeInfo type 
)
virtual

Determines if the XmlResolver::GetEntity() can return objects of the specified type.

Parameters
absoluteUriIGNORED
typeThe type to check
Returns
True if type is supported by XmlResolver::GetEntity(), otherwise - false

◆ UnescapeRelativeUriBody()

static String System::Xml::XmlResolver::UnescapeRelativeUriBody ( const String src)
staticprotected

Unescapes the specified string.

Parameters
srcThe string to unescape
Returns
The unescaped string