csharp-to-cpp/apireference/uri_8h_source.html

#pragma once


#include <system/uri_enum_types.h>

#include <system/uri_host_name_type.h>

#include <system/uri_partial.h>

#include <system/string_comparison.h>

#include <system/string.h>

#include <system/shared_ptr.h>

#include <system/object.h>

#include <cstdint>


namespace System {


namespace UriDetails { class UriImpl; }


class ASPOSECPP_SHARED_CLASS Uri : public Object

{

    typedef Uri ThisType;

    typedef Object BaseType;


    typedef BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;

    ASPOSECPP_SHARED_RTTI_INFO_DECL();


    friend ASPOSECPP_SHARED_API bool operator ==(const SharedPtr<Uri>& uri1, const SharedPtr<Uri>& uri2);

    friend ASPOSECPP_SHARED_API bool operator !=(const SharedPtr<Uri>& uri1, const SharedPtr<Uri>& uri2);


public:

    static const ASPOSECPP_SHARED_API String UriSchemeFile;

    static const ASPOSECPP_SHARED_API String UriSchemeFtp;

    static const ASPOSECPP_SHARED_API String UriSchemeGopher;

    static const ASPOSECPP_SHARED_API String UriSchemeHttp;

    static const ASPOSECPP_SHARED_API String UriSchemeHttps;

    static const ASPOSECPP_SHARED_API String UriSchemeMailto;

    static const ASPOSECPP_SHARED_API String UriSchemeNews;

    static const ASPOSECPP_SHARED_API String UriSchemeNntp;

    static const ASPOSECPP_SHARED_API String UriSchemeNetTcp;

    static const ASPOSECPP_SHARED_API String UriSchemeNetPipe;

    static const ASPOSECPP_SHARED_API String SchemeDelimiter;


    ASPOSECPP_SHARED_API String get_AbsolutePath() const;

    ASPOSECPP_SHARED_API String get_AbsoluteUri() const;

    ASPOSECPP_SHARED_API String get_LocalPath() const;

    ASPOSECPP_SHARED_API String get_Authority() const;

    ASPOSECPP_SHARED_API UriHostNameType get_HostNameType() const;

    ASPOSECPP_SHARED_API bool get_IsDefaultPort() const;

    ASPOSECPP_SHARED_API bool get_IsFile() const;

    ASPOSECPP_SHARED_API bool get_IsLoopback() const;

    ASPOSECPP_SHARED_API String get_PathAndQuery() const;

    ASPOSECPP_SHARED_API ArrayPtr<String> get_Segments() const;

    ASPOSECPP_SHARED_API bool get_IsUnc() const;

    ASPOSECPP_SHARED_API String get_Host() const;

    ASPOSECPP_SHARED_API int32_t get_Port() const;

    ASPOSECPP_SHARED_API String get_Query() const;

    ASPOSECPP_SHARED_API String get_Fragment() const;

    ASPOSECPP_SHARED_API String get_Scheme() const;

    ASPOSECPP_SHARED_API String get_OriginalString() const;

    ASPOSECPP_SHARED_API String get_DnsSafeHost() const;

    ASPOSECPP_SHARED_API String get_IdnHost() const;

    ASPOSECPP_SHARED_API bool get_IsAbsoluteUri() const;

    ASPOSECPP_SHARED_API bool get_UserEscaped() const;

    ASPOSECPP_SHARED_API String get_UserInfo() const;


    ASPOSECPP_SHARED_API Uri(const String& uriString);

    ASPOSECPP_SHARED_API Uri(const String& uriString, bool dontEscape);

    ASPOSECPP_SHARED_API Uri(const SharedPtr<Uri>& baseUri, const String& relativeUri, bool dontEscape);

    ASPOSECPP_SHARED_API Uri(const String& uriString, UriKind uriKind);

    ASPOSECPP_SHARED_API Uri(const SharedPtr<Uri>& baseUri, const String& relativeUri);

    ASPOSECPP_SHARED_API Uri(const SharedPtr<Uri>& baseUri, const SharedPtr<Uri>& relativeUri);


    static ASPOSECPP_SHARED_API UriHostNameType CheckHostName(String name);

    ASPOSECPP_SHARED_API String GetLeftPart(UriPartial part);

    static ASPOSECPP_SHARED_API String HexEscape(char16_t character);

    static ASPOSECPP_SHARED_API char16_t HexUnescape(const String& pattern, int32_t& index);

    static ASPOSECPP_SHARED_API bool IsHexEncoding(const String& pattern, int32_t index);

    static ASPOSECPP_SHARED_API bool CheckSchemeName(const String& schemeName);

    static ASPOSECPP_SHARED_API bool IsHexDigit(char16_t character);

    static ASPOSECPP_SHARED_API int32_t FromHex(char16_t digit);

    virtual ASPOSECPP_SHARED_API int32_t GetHashCode() const override;

    virtual ASPOSECPP_SHARED_API String ToString() const override;

    virtual ASPOSECPP_SHARED_API bool Equals(SharedPtr<Object> comparand) override;

    ASPOSECPP_SHARED_API SharedPtr<Uri> MakeRelativeUri(const SharedPtr<Uri>& uri);

    ASPOSECPP_SHARED_API String MakeRelative(const SharedPtr<Uri>& toUri);

    static ASPOSECPP_SHARED_API bool TryCreate(const String& uriString, UriKind uriKind, SharedPtr<Uri>& result);

    static ASPOSECPP_SHARED_API bool TryCreate(const SharedPtr<Uri>& baseUri, const String& relativeUri, SharedPtr<Uri>& result);

    static ASPOSECPP_SHARED_API bool TryCreate(const SharedPtr<Uri>& baseUri, const SharedPtr<Uri>& relativeUri, SharedPtr<Uri>& result);

    ASPOSECPP_SHARED_API String GetComponents(UriComponents components, UriFormat format) const;

    static ASPOSECPP_SHARED_API int32_t Compare(const SharedPtr<Uri>& uri1, const SharedPtr<Uri>& uri2,

                                                UriComponents partsToCompare,

                                                UriFormat compareFormat, StringComparison comparisonType);

    ASPOSECPP_SHARED_API bool IsWellFormedOriginalString() const;

    static ASPOSECPP_SHARED_API bool IsWellFormedUriString(const String& uriString, UriKind uriKind);

    static ASPOSECPP_SHARED_API String UnescapeDataString(const String& stringToUnescape);

    static ASPOSECPP_SHARED_API String EscapeUriString(const String& stringToEscape);

    static ASPOSECPP_SHARED_API String EscapeDataString(const String& stringToEscape);

    ASPOSECPP_SHARED_API bool IsBaseOf(const SharedPtr<Uri>& uri) const;


protected:

    virtual ASPOSECPP_SHARED_API void Parse();

    virtual ASPOSECPP_SHARED_API void Canonicalize();

    virtual ASPOSECPP_SHARED_API void Escape();

    virtual ASPOSECPP_SHARED_API String Unescape(const String& path);

    static ASPOSECPP_SHARED_API String EscapeString(const String& str);

    virtual ASPOSECPP_SHARED_API void CheckSecurity();

    virtual ASPOSECPP_SHARED_API bool IsReservedCharacter(char16_t character);

    static ASPOSECPP_SHARED_API bool IsExcludedCharacter(char16_t character);

    virtual ASPOSECPP_SHARED_API bool IsBadFileSystemCharacter(char16_t character);

#ifdef ASPOSE_GET_SHARED_MEMBERS

    ASPOSECPP_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;

#endif


private:

    explicit Uri(const SharedPtr<UriDetails::UriImpl>& impl);

    MEMBER_FUNCTION_MAKE_OBJECT(Uri, CODEPORTING_ARGS(const SharedPtr<UriDetails::UriImpl>& impl), CODEPORTING_ARGS(impl));


    static SharedPtr<UriDetails::UriImpl> GetImpl(const SharedPtr<Uri>& uri);

    SharedPtr<UriDetails::UriImpl> m_impl;

};


ASPOSECPP_SHARED_API bool operator ==(const SharedPtr<Uri>& uri1, const SharedPtr<Uri>& uri2);

ASPOSECPP_SHARED_API bool operator !=(const SharedPtr<Uri>& uri1, const SharedPtr<Uri>& uri2);


} // namespace System

System::Object
Base class that enables using methods available for System.Object class in C#. All non-trivial classe...
Definition: object.h:62

System::SmartPtr
Pointer class to wrap types being allocated on heap. Use it to manage memory for classes inheriting O...
Definition: smart_ptr.h:180

System::String
String class used across the library. Is a substitute for C# System.String when translating code....
Definition: string.h:122

System::Uri
Unified resource identifier. Objects of this class should only be allocated using System::MakeObject(...
Definition: uri.h:66

System::Uri::Unescape
virtual String Unescape(const String &path)
Obsolete method.

System::Uri::get_OriginalString
String get_OriginalString() const
Returns the URI string that was passed to the constructor when current object was constructed.

System::Uri::get_Segments
ArrayPtr< String > get_Segments() const
Returns an array of strings containing the path segments of the URI represented by the current object...

System::Uri::Canonicalize
virtual void Canonicalize()
Obsolete method.

System::Uri::GetLeftPart
String GetLeftPart(UriPartial part)
Returns the specified portion of the URI represented by the current object.

System::Uri::UriSchemeNetTcp
static const String UriSchemeNetTcp
Specifies that the Uri is accessed through the NetTcp scheme used by Windows Communication Foundation...
Definition: uri.h:94

System::Uri::EscapeDataString
static String EscapeDataString(const String &stringToEscape)
Converts a string to its escaped representation.

System::Uri::Uri
Uri(const String &uriString, UriKind uriKind)
Constructs a Uri object that represents the specified URI; an argument specifies the URI kind.

System::Uri::SchemeDelimiter
static const String SchemeDelimiter
Specifies the characters that separate the communication protocol scheme from the address portion of ...
Definition: uri.h:98

System::Uri::Uri
Uri(const SharedPtr< Uri > &baseUri, const SharedPtr< Uri > &relativeUri)
Constructs an Uri abject from the specified base and relative URIs.

System::Uri::get_LocalPath
String get_LocalPath() const
Returns the operating system representation of the file name referenced by the URI represented by the...

System::Uri::IsExcludedCharacter
static bool IsExcludedCharacter(char16_t character)
Obsolete method.

System::Uri::get_Query
String get_Query() const
Returns the query information included in the URI represented by the current object.

System::Uri::UriSchemeGopher
static const String UriSchemeGopher
Specifies that the Uri is accessed through the Gopher protocol.
Definition: uri.h:82

System::Uri::UriSchemeMailto
static const String UriSchemeMailto
Specifies that the Uri is an email address and is accessed through the Simple Mail Transport Protocol...
Definition: uri.h:88

System::Uri::Escape
virtual void Escape()
Obsolete method.

System::Uri::Uri
Uri(const SharedPtr< Uri > &baseUri, const String &relativeUri, bool dontEscape)
Constructs an Uri abject from the specified Uri object representing the base URI and the string repre...

System::Uri::get_IsDefaultPort
bool get_IsDefaultPort() const
Determines if the URI represented by the current object has default port for the URI's scheme.

System::Uri::UriSchemeHttps
static const String UriSchemeHttps
Specifies that the Uri is accessed through the Secure Hypertext Transfer Protocol.
Definition: uri.h:86

System::Uri::HexUnescape
static char16_t HexUnescape(const String &pattern, int32_t &index)
Converts the specified hexadecimal representation of a character to a character.

System::Uri::IsBadFileSystemCharacter
virtual bool IsBadFileSystemCharacter(char16_t character)
Obsolete method.

System::Uri::UriSchemeNetPipe
static const String UriSchemeNetPipe
Specifies that the Uri is accessed through the NetPipe scheme used by Windows Communication Foundatio...
Definition: uri.h:96

System::Uri::get_AbsolutePath
String get_AbsolutePath() const
Returns the absolute path of the URI.

System::Uri::Uri
Uri(const String &uriString)
Constructs a Uri object that represents the specified URI.

System::Uri::get_IsUnc
bool get_IsUnc() const
Determines if the URI represented by the current object is a UNC path.

System::Uri::IsWellFormedOriginalString
bool IsWellFormedOriginalString() const
Indicates whether the string used to construct this Uri was well-formed and is not required to be fur...

System::Uri::ToString
virtual String ToString() const override
Returns the string representation of the URI represented by the current object.

System::Uri::get_Scheme
String get_Scheme() const
Returns the scheme of the URI represented by the current object.

System::Uri::get_Host
String get_Host() const
Returns the host name.

System::Uri::get_UserEscaped
bool get_UserEscaped() const
Determines if the URI string passed to the constructor of the current object was fully escaped.

System::Uri::GetHashCode
virtual int32_t GetHashCode() const override
Gets the hash code for the URI.

System::Uri::Uri
Uri(const SharedPtr< Uri > &baseUri, const String &relativeUri)
Constructs an Uri abject from the specified base and relative URIs.

System::Uri::EscapeUriString
static String EscapeUriString(const String &stringToEscape)
Converts a URI string to its escaped representation.

System::Uri::get_HostNameType
UriHostNameType get_HostNameType() const
Returns the host name type.

System::Uri::UriSchemeFile
static const String UriSchemeFile
Specifies that the Uri is a pointer to a file.
Definition: uri.h:78

System::Uri::TryCreate
static bool TryCreate(const SharedPtr< Uri > &baseUri, const SharedPtr< Uri > &relativeUri, SharedPtr< Uri > &result)
Constructs an Uri abject from the specified base and relative URIs.

System::Uri::Compare
static int32_t Compare(const SharedPtr< Uri > &uri1, const SharedPtr< Uri > &uri2, UriComponents partsToCompare, UriFormat compareFormat, StringComparison comparisonType)
Compares the specified Uri objects using the specified comparison rules.

System::Uri::HexEscape
static String HexEscape(char16_t character)
Returns a hexadecimal equivalent of the specified character.

System::Uri::get_IsLoopback
bool get_IsLoopback() const
Determines if the URI represented by the current object references a local host.

System::Uri::get_IsFile
bool get_IsFile() const
Determines if the URI represented by the current object is a file.

System::Uri::CheckSchemeName
static bool CheckSchemeName(const String &schemeName)
Determines if the specified scheme is valid.

System::Uri::MakeRelativeUri
SharedPtr< Uri > MakeRelativeUri(const SharedPtr< Uri > &uri)
Determines the difference between URIs represented by the current and the specified Uri objects.

System::Uri::get_PathAndQuery
String get_PathAndQuery() const
Returns the absolute path and query components of the URI represented by the current object separated...

System::Uri::CheckSecurity
virtual void CheckSecurity()
Obsolete method.

System::Uri::get_Authority
String get_Authority() const
Returns the host name and the port number for a server.

System::Uri::Uri
Uri(const String &uriString, bool dontEscape)
Constructs a Uri object that represents the specified URI; an argument specifies if the URI should be...

System::Uri::get_DnsSafeHost
String get_DnsSafeHost() const
Returns an unescaped host name.

System::Uri::UriSchemeFtp
static const String UriSchemeFtp
Specifies that the Uri is accessed through the File Transfer Protocol.
Definition: uri.h:80

System::Uri::Parse
virtual void Parse()
Obsolete method.

System::Uri::UriSchemeHttp
static const String UriSchemeHttp
Specifies that the Uri is accessed through the Hypertext Transfer Protocol.
Definition: uri.h:84

System::Uri::IsHexEncoding
static bool IsHexEncoding(const String &pattern, int32_t index)
Determines if a character in the specified string at the specified position is hexadecimal encoded.

System::Uri::get_AbsoluteUri
String get_AbsoluteUri() const
Returns the absolute URI.

System::Uri::Equals
virtual bool Equals(SharedPtr< Object > comparand) override
Determines if the URIs represented by the current and specified objects are equal.

System::Uri::FromHex
static int32_t FromHex(char16_t digit)
Gets the decimal value of a hexadecimal digit.

System::Uri::CheckHostName
static UriHostNameType CheckHostName(String name)
Determines the type of the specified host name.

System::Uri::get_UserInfo
String get_UserInfo() const
Returns a uer name, password and other user information associated with the URI represented by the cu...

System::Uri::UriSchemeNews
static const String UriSchemeNews
Specifies that the Uri is an Internet news group and is accessed through the Network News Transport P...
Definition: uri.h:90

System::Uri::IsBaseOf
bool IsBaseOf(const SharedPtr< Uri > &uri) const
Determines of the URI represented by the current Uri object is a base of URI represented by the speci...

System::Uri::UnescapeDataString
static String UnescapeDataString(const String &stringToUnescape)
Unescapes the specified escaped string.

System::Uri::get_Port
int32_t get_Port() const
Returns the port number of the URI represented by the current object.

System::Uri::get_Fragment
String get_Fragment() const
Returns the escaped URI fragment.

System::Uri::IsHexDigit
static bool IsHexDigit(char16_t character)
Determines if the specified character represents a valid hexadecimal digit.

System::Uri::get_IdnHost
String get_IdnHost() const
Returns an International Domain Name of the host.

System::Uri::get_IsAbsoluteUri
bool get_IsAbsoluteUri() const
Determines if the URI represented by the current object is absolute.

System::Uri::IsWellFormedUriString
static bool IsWellFormedUriString(const String &uriString, UriKind uriKind)
Determines if the specified string is a well-formed URI.

System::Uri::GetComponents
String GetComponents(UriComponents components, UriFormat format) const
Returns the specified components of the URI represented by the current object using the specified esc...

System::Uri::TryCreate
static bool TryCreate(const String &uriString, UriKind uriKind, SharedPtr< Uri > &result)
Constructs a Uri object that represents the specified URI; an argument specifies the URI kind.

System::Uri::IsReservedCharacter
virtual bool IsReservedCharacter(char16_t character)
Obsolete method.

System::Uri::UriSchemeNntp
static const String UriSchemeNntp
Specifies that the Uri is an Internet news group and is accessed through the Network News Transport P...
Definition: uri.h:92

System::Uri::MakeRelative
String MakeRelative(const SharedPtr< Uri > &toUri)
Determines the difference between two Uri instances.

System::Uri::TryCreate
static bool TryCreate(const SharedPtr< Uri > &baseUri, const String &relativeUri, SharedPtr< Uri > &result)
Constructs an Uri abject from the specified Uri object representing the base URI and the string repre...

System::Uri::EscapeString
static String EscapeString(const String &str)
Obsolete method.

System
Definition: db_command.h:9

System::operator!=
bool operator!=(ArraySegment< T > a, ArraySegment< T > b)
Definition: array_segment.h:157

System::UriKind
UriKind
Represents the kinds of URIs.
Definition: uri_enum_types.h:13

System::StringComparison
StringComparison
Defines string comparison style.
Definition: string_comparison.h:13

System::UriHostNameType
UriHostNameType
Represents the type of host name.
Definition: uri_host_name_type.h:11

System::UriPartial
UriPartial
Represents the parts of a URI for the Uri.GetLeftPart method.
Definition: uri_partial.h:11

System::UriFormat
UriFormat
Specifies how the URI is escaped.
Definition: uri_enum_types.h:67

System::UriComponents
UriComponents
Represents URI components.
Definition: uri_enum_types.h:24

System::operator==
bool operator==(ArraySegment< T > a, ArraySegment< T > b)
Definition: array_segment.h:151