System.Web.HttpServerUtility.cs

#region 程序集 System.Web, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
// C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.6.1\System.Web.dll
#endregion

using System.Collections.Specialized;
using System.IO;

namespace System.Web
{
    //
    // 摘要:
    //     提供用于处理 Web 请求的 Helper 方法。
    public sealed class HttpServerUtility
    {
        //
        // 摘要:
        //     获取和设置请求超时值（以秒计）。
        //
        // 返回结果:
        //     请求的超时值设置。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     当前的 System.Web.HttpContext 为 null。
        //
        //   T:System.ArgumentOutOfRangeException:
        //     超时期限是 null 或否则无法设置。
        public int ScriptTimeout { get; set; }
        //
        // 摘要:
        //     获取服务器的计算机名称。
        //
        // 返回结果:
        //     本地计算机的名称。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     找不到计算机名称。
        public string MachineName { get; }

        //
        // 摘要:
        //     将 URL 字符串标记解码为使用 64 进制数字的等效字节数组。
        //
        // 参数:
        //   input:
        //     要解码的 URL 字符串标记。
        //
        // 返回结果:
        //     包含解码后的 URL 字符串标记的字节数组。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     input 参数的值为 null。
        public static byte[] UrlTokenDecode(string input);
        //
        // 摘要:
        //     将一个字节数组编码为使用 Base 64 编码方案的等效字符串表示形式，Base 64 是一种适于通过 URL 传输数据的编码方案。
        //
        // 参数:
        //   input:
        //     要编码的字节数组。
        //
        // 返回结果:
        //     包含已编码的令牌如果字节数组的字符串 长度 大于 1; 否则为空字符串 ("")。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     input 参数的值为 null。
        public static string UrlTokenEncode(byte[] input);
        //
        // 摘要:
        //     清除前一个异常。
        public void ClearError();
        //
        // 摘要:
        //     创建 COM 对象的服务器实例，该 COM 对象由对象的程序标识符 (ProgID) 标识。
        //
        // 参数:
        //   progID:
        //     要创建其实例的对象的类或类型。
        //
        // 返回结果:
        //     新对象。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     无法创建对象的实例。
        public object CreateObject(string progID);
        //
        // 摘要:
        //     创建由对象类型标识的 COM 对象的一个服务器实例。
        //
        // 参数:
        //   type:
        //     一个 System.Type 表示要创建的对象。
        //
        // 返回结果:
        //     新对象。
        public object CreateObject(Type type);
        //
        // 摘要:
        //     创建 COM 对象的服务器实例，该对象由对象的类标识符 (CLSID) 标识。
        //
        // 参数:
        //   clsid:
        //     要创建其实例的对象的类标识符。
        //
        // 返回结果:
        //     新对象。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     无法创建对象的实例。
        public object CreateObjectFromClsid(string clsid);
        //
        // 摘要:
        //     在当前请求的上下文中执行指定虚拟路径的处理程序。
        //
        // 参数:
        //   path:
        //     要执行的 URL 路径。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     当前的 System.Web.HttpContext 为 null。 - 或 - 执行由指定的处理程序时出错 path。
        //
        //   T:System.ArgumentNullException:
        //     path 为 null。 - 或 - path 不是虚拟路径。
        public void Execute(string path);
        //
        // 摘要:
        //     在当前请求的上下文中执行指定虚拟路径的处理程序。 一个 System.IO.TextWriter 捕获执行的处理程序的输出。
        //
        // 参数:
        //   path:
        //     要执行的 URL 路径。
        //
        //   writer:
        //     System.IO.TextWriter 以捕获输出。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     当前的 System.Web.HttpContext 为 null。 - 或 - 执行由指定的处理程序时出错 path。
        //
        //   T:System.ArgumentNullException:
        //     path 为 null。 - 或 - path 不是虚拟路径。
        public void Execute(string path, TextWriter writer);
        //
        // 摘要:
        //     当前请求的上下文中执行指定虚拟路径的处理程序，并指定是否清除 System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form
        //     集合。
        //
        // 参数:
        //   path:
        //     要执行的 URL 路径。
        //
        //   preserveForm:
        //     若要保留 System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 true；如果要清除
        //     System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 false。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     当前的 System.Web.HttpContext 为 null。 - 或 - 执行由指定的处理程序时出错 path。
        //
        //   T:System.ArgumentNullException:
        //     path 为 null。 - 或 - path 不是虚拟路径。
        public void Execute(string path, bool preserveForm);
        //
        // 摘要:
        //     在当前请求的上下文中执行指定虚拟路径的处理程序。 一个 System.IO.TextWriter 捕获输出从页上，布尔参数则指定是否清除 System.Web.HttpRequest.QueryString
        //     和 System.Web.HttpRequest.Form 集合。
        //
        // 参数:
        //   path:
        //     要执行的 URL 路径。
        //
        //   writer:
        //     System.IO.TextWriter 以捕获输出。
        //
        //   preserveForm:
        //     若要保留 System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 true；如果要清除
        //     System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 false。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     当前 System.Web.HttpContext 为空引用 (Nothing 在 Visual Basic 中)。 - 或 - path 以句点 (.)
        //     结尾。 - 或 - 执行由指定的处理程序时出错 path。
        //
        //   T:System.ArgumentNullException:
        //     path 为 null。
        //
        //   T:System.ArgumentException:
        //     path 不是虚拟路径。
        public void Execute(string path, TextWriter writer, bool preserveForm);
        //
        // 摘要:
        //     在当前请求的上下文中执行指定虚拟路径的处理程序。 一个 System.IO.TextWriter 捕获输出从执行的处理程序和一个布尔型参数则指定是否清除
        //     System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合。
        //
        // 参数:
        //   handler:
        //     实现的 HTTP 处理程序 System.Web.IHttpHandler 要传输到当前的请求。
        //
        //   writer:
        //     System.IO.TextWriter 以捕获输出。
        //
        //   preserveForm:
        //     若要保留 System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 true；如果要清除
        //     System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 false。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     执行由指定的处理程序时出错 handler。
        //
        //   T:System.ArgumentNullException:
        //     handler 参数为 null。
        public void Execute(IHttpHandler handler, TextWriter writer, bool preserveForm);
        //
        // 摘要:
        //     返回前一个异常。
        //
        // 返回结果:
        //     引发的前一个异常。
        public Exception GetLastError();
        //
        // 摘要:
        //     对 HTML 编码的字符串进行解码并将结果发送到输出 System.IO.TextWriter 输出流。
        //
        // 参数:
        //   s:
        //     要解码的 HTML 字符串。
        //
        //   output:
        //     System.IO.TextWriter 输出流，其中包含已解码的字符串。
        public void HtmlDecode(string s, TextWriter output);
        //
        // 摘要:
        //     对 HTML 编码的字符串进行解码，并返回已解码的字符串。
        //
        // 参数:
        //   s:
        //     要解码的 HTML 字符串。
        //
        // 返回结果:
        //     已解码的文本。
        public string HtmlDecode(string s);
        //
        // 摘要:
        //     对字符串进行 HTML 编码并返回已编码的字符串。
        //
        // 参数:
        //   s:
        //     要编码的文本字符串。
        //
        // 返回结果:
        //     HTML 编码的文本。
        public string HtmlEncode(string s);
        //
        // 摘要:
        //     对字符串进行 HTML 编码并将结果输出发送到 System.IO.TextWriter 输出流。
        //
        // 参数:
        //   s:
        //     要编码的字符串。
        //
        //   output:
        //     System.IO.TextWriter 输出流，其中包含已编码的字符串。
        public void HtmlEncode(string s, TextWriter output);
        //
        // 摘要:
        //     返回与指定虚拟路径相对应的物理路径。
        //
        // 参数:
        //   path:
        //     Web 应用程序中的虚拟路径。
        //
        // 返回结果:
        //     对应的 Web 服务器上的物理文件路径 path。
        //
        // 异常:
        //   T:System.Web.HttpException:
        //     当前的 System.Web.HttpContext 为 null。
        public string MapPath(string path);
        //
        // 摘要:
        //     终止当前页的执行并使用实现一个自定义 HTTP 处理程序来开始执行新请求 System.Web.IHttpHandler 接口，并指定是否清除 System.Web.HttpRequest.QueryString
        //     和 System.Web.HttpRequest.Form 集合。
        //
        // 参数:
        //   handler:
        //     实现的 HTTP 处理程序 System.Web.IHttpHandler 要传输到当前的请求。
        //
        //   preserveForm:
        //     若要保留 System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 true；如果要清除
        //     System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 false。
        //
        // 异常:
        //   T:System.ApplicationException:
        //     当前页面请求为回调。
        public void Transfer(IHttpHandler handler, bool preserveForm);
        //
        // 摘要:
        //     对于当前请求，终止当前页的执行，并使用指定的页 URL 路径来开始执行一个新页。
        //
        // 参数:
        //   path:
        //     服务器上要执行的新页的 URL 路径。
        public void Transfer(string path);
        //
        // 摘要:
        //     终止当前页的执行，并使用指定的页 URL 路径来开始执行一个新页。 指定是否清除 System.Web.HttpRequest.QueryString 和
        //     System.Web.HttpRequest.Form 集合。
        //
        // 参数:
        //   path:
        //     服务器上要执行的新页的 URL 路径。
        //
        //   preserveForm:
        //     若要保留 System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 true；如果要清除
        //     System.Web.HttpRequest.QueryString 和 System.Web.HttpRequest.Form 集合，则为 false。
        //
        // 异常:
        //   T:System.ApplicationException:
        //     当前页面请求为回调。
        public void Transfer(string path, bool preserveForm);
        //
        // 摘要:
        //     使用指定的 HTTP 方法和标头异步执行指定的 URL。
        //
        // 参数:
        //   path:
        //     服务器上要执行的新页的 URL 路径。
        //
        //   preserveForm:
        //     true 若要保留 System.Web.HttpRequest.Form 集合; false 以清除 System.Web.HttpRequest.Form
        //     集合。
        //
        //   method:
        //     在执行新请求时使用的 HTTP 方法。
        //
        //   headers:
        //     一个 System.Collections.Specialized.NameValueCollection 的新请求的请求标头。
        //
        // 异常:
        //   T:System.PlatformNotSupportedException:
        //     该请求要求在集成模式下运行的 IIS 7.0。
        //
        //   T:System.Web.HttpException:
        //     服务器不可用于处理该请求。
        //
        //   T:System.ArgumentNullException:
        //     path 参数为 null。
        //
        //   T:System.ArgumentException:
        //     path 参数无效。
        public void TransferRequest(string path, bool preserveForm, string method, NameValueCollection headers);
        //
        // 摘要:
        //     用指定的 HTTP 方法、标头和路径，执行指定的 URL 上的异步执行和选择保留格式值和用户标识。
        //
        // 参数:
        //   path:
        //     路径。
        //
        //   preserveForm:
        //     true 若要保留 System.Web.HttpRequest.Form 集合; false 以清除 System.Web.HttpRequest.Form
        //     集合。
        //
        //   method:
        //     要在新请求中使用的 HTTP 方法。
        //
        //   headers:
        //     一个 System.Collections.Specialized.NameValueCollection 对象，其中包含用于新请求的请求标头。
        //
        //   preserveUser:
        //     true 若要保留的用户标识;否则为 false。 此方法的其他方法重载调用此重载且此参数设置为 true。
        //
        // 异常:
        //   T:System.PlatformNotSupportedException:
        //     该请求需要 IIS 7.0 的集成管道模式。
        //
        //   T:System.Web.HttpException:
        //     服务器不可用于处理该请求。
        //
        //   T:System.ArgumentNullException:
        //     path 参数为 null。
        //
        //   T:System.ArgumentException:
        //     path 参数无效。
        public void TransferRequest(string path, bool preserveForm, string method, NameValueCollection headers, bool preserveUser);
        //
        // 摘要:
        //     异步执行指定的 URL。
        //
        // 参数:
        //   path:
        //     服务器上要执行的新页的 URL 路径。
        //
        // 异常:
        //   T:System.PlatformNotSupportedException:
        //     该请求需要 IIS 7.0 的集成管道模式。
        //
        //   T:System.Web.HttpException:
        //     服务器不可用于处理该请求。
        //
        //   T:System.ArgumentNullException:
        //     path 参数为 null。
        //
        //   T:System.ArgumentException:
        //     path 参数无效。
        public void TransferRequest(string path);
        //
        // 摘要:
        //     异步执行指定的 URL 并保留查询字符串参数。
        //
        // 参数:
        //   path:
        //     服务器上要执行的新页的 URL 路径。
        //
        //   preserveForm:
        //     true 若要保留 System.Web.HttpRequest.Form 集合; false 以清除 System.Web.HttpRequest.Form
        //     集合。
        //
        // 异常:
        //   T:System.PlatformNotSupportedException:
        //     该请求需要 IIS 7.0 的集成管道模式。
        //
        //   T:System.Web.HttpException:
        //     服务器不可用于处理该请求。
        //
        //   T:System.ArgumentNullException:
        //     path 参数为 null。
        //
        //   T:System.ArgumentException:
        //     path 参数无效。
        public void TransferRequest(string path, bool preserveForm);
        //
        // 摘要:
        //     对字符串进行 URL 解码并返回已解码的字符串。
        //
        // 参数:
        //   s:
        //     要解码的文本字符串。
        //
        // 返回结果:
        //     已解码的文本。
        public string UrlDecode(string s);
        //
        // 摘要:
        //     对在 URL 中接收的 HTML 字符串进行解码并将结果发送到输出 System.IO.TextWriter 输出流。
        //
        // 参数:
        //   s:
        //     要解码的 HTML 字符串。
        //
        //   output:
        //     System.IO.TextWriter 输出流，其中包含已解码的字符串。
        public void UrlDecode(string s, TextWriter output);
        //
        // 摘要:
        //     对字符串进行 URL 编码，并返回已编码的字符串。
        //
        // 参数:
        //   s:
        //     要进行 URL 编码的文本。
        //
        // 返回结果:
        //     URL 编码的文本。
        public string UrlEncode(string s);
        //
        // 摘要:
        //     对字符串进行 URL 编码并将结果输出发送到 System.IO.TextWriter 输出流。
        //
        // 参数:
        //   s:
        //     要编码的文本字符串。
        //
        //   output:
        //     System.IO.TextWriter 输出流，其中包含已编码的字符串。
        public void UrlEncode(string s, TextWriter output);
        //
        // 摘要:
        //     请勿使用；仅适用于浏览器兼容性。 请使用 System.Web.HttpServerUtility.UrlEncode(System.String)。
        //
        // 参数:
        //   s:
        //     要进行 URL 编码的文本。
        //
        // 返回结果:
        //     URL 已编码的文本。
        public string UrlPathEncode(string s);
    }
}