Application Program Interface for Network Software Platform

[0001] The present application claims priority under 35 U.S.C. §120 as a continuation of U.S. patent application Ser. No. 09/902,809, filed Jul. 10, 2001, to Anders et al., and titled “Application Program Interface for Network Software Platform”, the disclosure of which is hereby incorporated by reference in its entirety.

[0002] This invention relates to network software, such as Web applications, and to computer software development of such network software. More particularly, this invention relates to an application program interface (API) that facilitates use of a network software platform by application programs and computer hardware.

[0003] Very early on, computer software came to be categorized as “operating system” software or “application” software. Broadly speaking, an application is software meant to perform a specific task for the computer user such as solving a mathematical equation or supporting word processing. The operating system is the software that manages and controls the computer hardware. The goal of the operating system is to make the computer resources available to the application programmer while at the same time, hiding the complexity necessary to actually control the hardware.

[0004] The operating system makes the resources available via functions that are collectively known as the Application Program Interface or API. The term API is also used in reference to a single one of these functions. The functions are often grouped in terms of what resource or service they provide to the application programmer. Application software requests resources by calling individual API functions. API functions also serve as the means by which messages and information provided by the operating system are relayed back to the application software.

[0005] In addition to changes in hardware, another factor driving the evolution of operating system software has been the desire to simplify and speed application software development. Application software development can be a daunting task, sometimes requiring years of developer time to create a sophisticated program with millions of lines of code. For a popular operating system such as Microsoft Windows®, application software developers write thousands of different applications each year that utilize the operating system. A coherent and usable operating system base is required to support so many diverse application developers.

[0006] Often, development of application software can be made simpler by making the operating system more complex. That is, if a function may be useful to several different application programs, it may be better to write it once for inclusion in the operating system, than requiring dozens of software developers to write it dozens of times for inclusion in dozens of different applications. In this manner, if the operating system supports a wide range of common functionality required by a number of applications, significant savings in applications software development costs and time can be achieved.

[0007] Regardless of where the line between operating system and application software is drawn, it is clear that for a useful operating system, the API between the operating system and the computer hardware and application software is as important as efficient internal operation of the operating system itself.

[0008] Over the past few years, the universal adoption of the Internet, and networking technology in general, has changed the landscape for computer software developers. Traditionally, software developers focused on single-site software applications for standalone desktop computers, or LAN-based computers that were connected to a limited number of other computers via a local area network (LAN). Such software applications were typically referred to as “shrink wrapped” products because the software was marketed and sold in a shrink-wrapped package. The applications utilized well-defined APIs to access the underlying operating system of the computer.

[0009] As the Internet evolved and gained widespread acceptance, the industry began to recognize the power of hosting applications at various sites on the World Wide Web (or simply the “Web”). In the networked world, clients from anywhere could submit requests to server-based applications hosted at diverse locations and receive responses back in fractions of a second. These Web applications, however, were typically developed using the same operating system platform that was originally developed for standalone computing machines or locally networked computers. Unfortunately, in some instances, these applications do not adequately transfer to the distributed computing regime. The underlying platform was simply not constructed with the idea of supporting limitless numbers of interconnected computers.

[0010] To accommodate the shift to the distributed computing environment being ushered in by the Internet, Microsoft Corporation is developing a network software platform known as the “.NET” platform (read as “Dot Net”). The platform allows developers to create Web services that will execute over the Internet. Such a dynamic shift requires a new ground-up design of an entirely new API.

[0011] In response to this challenge, the inventors developed a unique set of API functions for Microsoft's .NET™ platform.

[0012] An application program interface (API) provides a set of functions for application developers who build Web applications on a network platform, such as Microsoft Corporation's .NET™ platform.

[0013] The same numbers are used throughout the drawings to reference like features.

[0014] FIG. 1 illustrates a network architecture in which clients access Web services over the Internet using conventional protocols.

[0015] FIG. 2 is a block diagram of a software architecture for Microsoft's .NET™ platform, which includes an application program interface (API).

[0016] FIG. 3 is a block diagram of unique namespaces supported by the API, as well as function classes of the various API functions.

[0017] FIG. 4 is a block diagram of an exemplary computer that may execute all or part of the software architecture.

[0018] Accompanying this specification is a compact disc that stores a compiled HTML help file identifying the API (application program interface) for Microsoft's .NET™ network platform. The file is named “cpref.chm” and was created on Jun. 8, 2001. It is 30.81 Mbytes in size. The file can be executed on a Windows®-based computing device (e.g., IBM-PC, or equivalent) that executes a Windows®-brand operating system (e.g., Windows® NT, Windows® 98, Windows® 2000, etc.). The compiled HTML help file stored on the compact disk is hereby incorporated by reference.

[0019] Additionally, the APIs contained in the compiled HTML help file are also provided in approximately 100 separate text files named “NamespaceName.txt”. The text files comply with the ASCII format.

[0020] The compact disc itself is a CD-ROM, and conforms to the ISO 9660 standard.

[0021] This disclosure addresses an application program interface (API) for a network platform upon which developers can build Web applications and services. More particularly, an exemplary API is described for the .NET™ platform created by Microsoft Corporation. The .NET™ platform is a software platform for Web services and Web applications implemented in the distributed computing environment. It represents the next generation of Internet computing, using open communication standards to communicate among loosely coupled Web services that are collaborating to perform a particular task.

[0022] In the described implementation, the .NET™ platform utilizes XML (extensible markup language), an open standard for describing data. XML is managed by the World Wide Web Consortium (W3C). XML is used for defining data elements on a Web page and business-to-business documents. XML uses a similar tag structure as HTML; however, whereas HTML defines how elements are displayed, XML defines what those elements contain. HTML uses predefined tags, but XML allows tags to be defined by the developer of the page. Thus, virtually any data items can be identified, allowing Web pages to function like database records. Through the use of XML and other open protocols, such as Simple Object Access Protocol (SOAP), the .NET™ platform allows integration of a wide range of services that can be tailored to the needs of the user. Although the embodiments described herein are described in conjunction with XML and other open standards, such are not required for the operation of the claimed invention. Other equally viable technologies will suffice to implement the inventions described herein.

[0023] As used herein, the phrase application program interface or API includes traditional interfaces that employ method or function calls, as well as remote calls (e.g., a proxy, stub relationship) and SOAP/XML invocations.

[0024] Exemplary Network Environment

[0025] FIG. 1 shows a network environment 100 in which a network platform, such as the .NET™ platform, may be implemented. The network environment 100 includes representative Web services 102(1), . . . , 102(N), which provide services that can be accessed over a network 104 (e.g., Internet). The Web services, referenced generally as number 102, are programmable application components that are reusable and interact programmatically over the network 104, typically through industry standard Web protocols, such as XML, SOAP, WAP (wireless application protocol), HTTP (hypertext transport protocol), and SMTP (simple mail transfer protocol) although other means of interacting with the Web services over the network may also be used, such as Remote Procedure Call (RPC) or object broker type technology. A Web service can be self-describing and is often defined in terms of formats and ordering of messages.

[0026] Web services 102 are accessible directly by other services (as represented by communication link 106) or a software application, such as Web application 110 (as represented by communication links 112 and 114). Each Web service 102 is illustrated as including one or more servers that execute software to handle requests for particular services. Such services often maintain databases that store information to be served back to requesters. Web services may be configured to perform any one of a variety of different services. Examples of Web services 11 include login verification, notification, database storage, stock quoting, location directories, mapping, music, electronic wallet, calendar/scheduler, telephone listings, news and information, games, ticketing, and so on. The Web services can be combined with each other and with other applications to build intelligent interactive experiences.

[0027] The network environment 100 also includes representative client devices 120(1), 120(2), 120(3), 120(4), . . . , 120(M) that utilize the Web services 102 (as represented by communication link 122) and/or the Web application 110 (as represented by communication links 124, 126, and 128). The clients may communicate with one another using standard protocols as well, as represented by an exemplary XML link 130 between clients 120(3) and 120(4).

[0028] The client devices, referenced generally as number 120, can be implemented many different ways. Examples of possible client implementations include, without limitation, portable computers, stationary computers, tablet PCs, televisions/set-top boxes, wireless communication devices, personal digital assistants, gaming consoles, printers, photocopiers, and other smart devices.

[0029] The Web application 110 is an application designed to run on the network platform and may utilize the Web services 102 when handling and servicing requests from clients 120. The Web application 110 is composed of one or more software applications 130 that run atop a programming framework 132, which are executing on one or more servers 134 or other computer systems. Note that a portion of Web application 110 may actually reside on one or more of clients 120. Alternatively, Web application 110 may coordinate with other software on clients 120 to actually accomplish its tasks.

[0030] The programming framework 132 is the structure that supports the applications and services developed by application developers. It permits multi-language development and seamless integration by supporting multiple languages. It supports open protocols, such as SOAP, and encapsulates the underlying operating system and object model services. The framework provides a robust and secure execution environment for the multiple programming languages and offers secure, integrated class libraries.

[0031] The framework 132 is a multi-tiered architecture that includes an application program interface (API) layer 142, a common language runtime (CLR) layer 144, and an operating system/services layer 146. This layered architecture allows updates and modifications to various layers without impacting other portions of the framework. A common language specification (CLS) 140 allows designers of various languages to write code that is able to access underlying library functionality. The specification 140 functions as a contract between language designers and library designers that can be used to promote language interoperability. By adhering to the CLS, libraries written in one language can be directly accessible to code modules written in other languages to achieve seamless integration between code modules written in one language and code modules written in another language. One exemplary detailed implementation of a CLS is described in an ECMA standard created by participants in ECMA TC39/TG3. The reader is directed to the ECMA web site at www.ecma.ch.

[0032] The API layer 142 presents groups of functions that the applications 130 can call to access the resources and services provided by layer 146. By exposing the API functions for a network platform, application developers can create Web applications for distributed computing systems that make full use of the network resources and other Web services, without needing to understand the complex interworkings of how those network resources actually operate or are made available. Moreover, the Web applications can be written in any number of programming languages, and translated into an intermediate language supported by the common language runtime 144 and included as part of the common language specification 140. In this way, the API layer 142 can provide methods for a wide and diverse variety of applications.

[0033] Additionally, the framework 132 can be configured to support API calls placed by remote applications executing remotely from the servers 134 that host the framework. Representative applications 148(1) and 148(2) residing on clients 120(3) and 120(M), respectively, can use the API functions by making calls directly, or indirectly, to the API layer 142 over the network 104.

[0034] The framework may also be implemented at the clients. Client 120(3) represents the situation where a framework 150 is implemented at the client. This framework may be identical to server-based framework 132, or modified for client purposes. Alternatively, the client-based framework may be condensed in the event that the client is a limited or dedicated function device, such as a cellular phone, personal digital assistant, handheld computer, or other communication/computing device.

[0035] Developers' Programming Framework

[0036] FIG. 2 shows the programming framework 132 in more detail. The common language specification (CLS) layer 140 supports applications written in a variety of languages 130(1), 130(2), 130(3), 130(4), . . . , 130(K). Such application languages include Visual Basic, C++, C#, COBOL, Jscript, Perl, Eiffel, Python, 11 and so on. The common language specification 140 specifies a subset of features or rules about features that, if followed, allow the various languages to communicate. For example, some languages do not support a given type (e.g., an “int*” type) that might otherwise be supported by the common language runtime 144. In this case, the common language specification 140 does not include the type. On the other hand, types that are supported by all or most languages (e.g., the “int[ ]” type) is included in common language specification 140 so library developers are free to use it and are assured that the languages can handle it. This ability to communicate results in seamless integration between code modules written in one language and code modules written in another language. Since different languages are particularly well suited to particular tasks, the seamless integration between languages allows a developer to select a particular language for a particular code module with the ability to use that code module with modules written in different languages. The common language runtime 144 allow seamless multi-language development, with cross language inheritance, and provide a robust and secure execution environment for the multiple programming languages. For more information on the common language specification 140 and the common language runtime 144, the reader is directed to co-pending applications entitled “Method and System for Compiling Multiple Languages”, filed Jun. 21, 2000 (Ser. No. 09/598,105) and “Unified Data Type System and Method” filed Jul. 10, 2000 (Ser. No. 09/613,289), which are incorporated by reference.

[0037] The framework 132 encapsulates the operating system 146(1) (e.g., Windows®-brand operating systems) and object model services 146(2) (e.g., Component Object Model (COM) or Distributed COM). The operating system 146(1) provides conventional functions, such as file management, notification, 11 event handling, user interfaces (e.g., windowing, menus, dialogs, etc.), security, authentication, verification, processes and threads, memory management, and so on. The object model services 146(2) provide interfacing with other objects to perform various tasks. Calls made to the API layer 142 are handed to the common language runtime layer 144 for local execution by the operating system 146(1) and/or object model services 146(2).

[0038] The API 142 groups API functions into multiple namespaces. Namespaces essentially define a collection of classes, interfaces, delegates, enumerations, and structures, which are collectively called “types”, that provide a specific set of related functionality. A class represents managed heap allocated data that has reference assignment semantics. A delegate is an object oriented function pointer. An enumeration is a special kind of value type that represents named constants. A structure represents static allocated data that has value assignment semantics. An interface defines a contract that other types can implement.

[0039] By using namespaces, a designer can organize a set of types into a hierarchical namespace. The designer is able to create multiple groups from the set of types, with each group containing at least one type that exposes logically related functionality. In the exemplary implementation, the API 142 is organized into four root namespaces: a first namespace 200 for Web applications, a second namespace 202 for client applications, a third namespace 204 for data and XML, and a fourth namespace 206 for base class libraries (BCLs). Each group can then be assigned a name. For instance, types in the Web applications namespace 200 are assigned the name “Web”, and types in the data and XML namespace 204 can be assigned names “Data” and “XML” respectively. The named groups can be 11 organized under a single “global root” namespace for system level APIs, such as an overall System namespace. By selecting and prefixing a top level identifier, the types in each group can be easily referenced by a hierarchical name that includes the selected top level identifier prefixed to the name of the group containing the type. For instance, types in the Web applications namespace 200 can be referenced using the hierarchical name “System.Web”. In this way, the individual namespaces 200, 202, 204, and 206 become major branches off of the System namespace and can carry a designation where the individual namespaces are prefixed with a designator, such as a “System.” prefix.

[0040] The Web applications namespace 200 pertains to Web based functionality, such as dynamically generated Web pages (e.g., Microsoft's Active Server Pages (ASP)). It supplies types that enable browser/server communication. The client applications namespace 202 pertains to drawing and client side UI functionality. It supplies types that enable drawing of two-dimensional (2D), imaging, and printing, as well as the ability to construct window forms, menus, boxes, and so on.

[0041] The data and XML namespace 204 relates to connectivity to data sources and XML functionality. It supplies classes, interfaces, delegates, and enumerations that enable security, specify data types, and serialize objects into XML format documents or streams. The base class libraries (BCL) namespace 206 pertains to basic system and runtime functionality. It contains the fundamental types and base classes that define commonly-used value and reference data types, events and event handlers, interfaces, attributes, and processing exceptions.

[0042] In addition to the framework 132, programming tools 210 are provided to assist the developer in building Web services and/or applications. One example of the programming tools 200 is Visual Studio™, a multi-language suite of programming tools offered by Microsoft Corporation.

[0043] Root API Namespaces

[0044] FIG. 3 shows the API 142 and its four root namespaces in more detail. In one embodiment, the namespaces are identified according to a hierarchical naming convention in which strings of names are concatenated with periods. For instance, the Web applications namespace 200 is identified by the root name “System.Web”. Within the “Sytem.Web” namespace is another namespace for Web services, identified as “System.Web.Services”, which further identifies another namespace for a description known as “System.Web.Services.Description”. With this naming convention in mind, the following provides a general overview of selected namespaces of the API 142, although other naming conventions could be used with equal effect.

[0045] The Web applications namespace 200 (“System.Web”) defines additional namespaces, including:

• • [0046] A services namespace 300 (“System.Web.Services”) containing classes that enable a developer to build and use Web services. The services namespace 300 defines additional namespaces, including a description namespace 302 (“System.Web.Services.Description”) containing classes that enable a developer to publicly describe a Web service via a service description language (such as WSDL, a specification available from the W3C), a discovery namespace 304 (“System.Web.Services.Discovery”) containing classes that allow Web service consumers to locate available Web Services on a Web server, and a protocols namespace 306 (“System.Web.Services.Protocols”) containing classes that define the protocols used to transmit data across a network during communication between Web service clients and the Web service itself.
  • [0047] A caching namespace 308 (“System.Web.Caching”) containing classes that enable developers to decrease Web application response time through temporarily caching frequently used resources on the server. This includes ASP.NET pages, web services, and user controls. (ASP.NET is the updated version of Microsoft's ASP technology.) Additionally, a cache dictionary is available for developers to store frequently used resources, such as hash tables and other data structures.
  • [0048] A configuration namespace 310 (“System.Web.Configuration”) containing classes that are used to read configuration data in for an application.
  • [0049] A UI namespace 312 (“System.Web.UI”) containing types that allow developers to create controls and pages that will appear in Web applications as user interfaces on a Web page. This namespace includes the control class, which provides all web based controls, whether those encapsulating HTML elements, higher level Web controls, or even custom User controls, with a common set of functionality. Also provided are classes which provide the web forms server controls data binding functionality, the ability to save the view state of a given control or page, as well as parsing functionality for both programmable and literal controls. Within the UI namespace 312 are two additional namespaces: an HTML controls namespace 314 (“System.Web.UI.HtmlControls”) containing classes that permit developers to interact with types that encapsulates html 3.2 elemtents create HTML controls, and a Web controls namespace 316 (“System.Web.UI.WeblControls”) containing classes that allow developers to create higher level Web controls.
  • [0050] A security namespace 318 (“System.Web.Security”) containing classes used to implement security in web server applications, such as basic authentication, challenge response authentication, and role based authentication.
  • [0051] A session state namespace 320 (“System.Web.SessionState”) containing classes used to access session state values (i.e., data that lives across requests for the lifetime of the session) as well as session-level settings and lifetime management methods.

[0052] The client applications namespace 202 is composed of two namespaces:

• • [0053] A windows forms namespace 322 (“System.Windows.Forms”) containing classes for creating Windows®-based client applications that take full advantage of the rich user interface features available in the Microsoft Windows® operating system, such as the ability to drag and drop screen elements. Such classes may include wrapped APIs available in the Microsoft Windows® operating system that are used in a windowing UI environment. Within this namespace are a design namespace 324 (“System.Windows.Forms.Design”) that contains classes to extend design-time support for Windows forms and a component model namespace 326 (“System.Windows.Forms.ComponentModel”) that contains the windows form implementation of the general component model defined in System.ComponentModel. This namespace contains designer tools, such as Visual Studio, which offer a rich experience for developers at design time.
  • [0054] A drawing namespace 328 (“System.Drawing”) containing classes for graphics functionality. The drawing namespace 328 includes a 2D drawing namespace 330 (“System.Drawing.Drawing2D”) that contains classes and enumerations to provide advanced 2-dimmensional and vector graphics functionality, an imaging namespace 332 (“System.Drawing.Imaging”) that contains classes for advanced imaging functionality, a printing namespace 334 (“System.Drawing.Printing”) that contains classes to permit developers to customize printing, and a text namespace 336 (“System.Drawing.Text”) that contains classes for advanced typography functionality.

[0055] The data and XML namespace 204 is composed of two namespaces:

• • [0056] A data namespace 340 (“System.Data”) containing classes that enable developers to build components that efficiently manage data from multiple data sources. It implements an architecture that, in a disconnected scenario (such as the Internet), provides tools to request, update, and reconcile data in multiple tier systems. The data namespace 340 includes a common namespace 342 that contains types shared by data providers. A data provider describes a collection of types used to access a data source, such as a database, in the managed space. The data namespace 340 also includes an OLE DB namespace 344 that contains types pertaining to data used in object-oriented databases (e.g., Microsoft's SQL Server), and a SQL client namespace 346 that contains types pertaining to data used by SQL clients. The data namespace also includes a SQL types namespace 348 (“System.Data.SqlTypes”) that contains classes for native data types within Microsoft's SQL Server. The classes provide a safer, faster alternative to other data types. Using the objects within this namespace helps prevent type conversion errors caused in situations where loss of precision could occur. Because other data types are converted to and from SQL types behind the scenes, explicitly creating and using objects within this namespace results in faster code as well.
  • [0057] An XML namespace 350 (“System.XML”) containing classes that provide standards-based support for processing XML. The supported standards include XML (e.g., version 1.0), XML Namespaces (both stream level and DOM), XML Schemas, XPath expressions, XSL/T transformations, DOM Level 2 Core, and SOAP (e.g., version 1.1). The XML namespace 350 includes an XSLT namespace 352 (“System.XML.Xsl”) that contains classes and enumerations to support XSLT (Extensible Stylesheet Language Transformations), an Xpath namespace 354 (“System.XML.Xpath”) that contains an XPath parser and evaluation engine, and a serialization namespace 356 (“System.XML.Serialization”) that contains classes used to serialize objects into XML format documents or streams.

[0058] The base class library namespace 206 (“System”) includes the following namespaces:

• • [0059] A collections namespace 360 (“System.Collections”) containing interfaces and classes that define various collections of objects, such as lists, queues, arrays, hash tables and dictionaries.
  • [0060] A configuration namespace 362 (“System.Configuration”) containing classes and interfaces that allow developers to programmatically access configuration settings and handle errors in configuration files.
  • [0061] A diagnostics namespace 364 (“System.Diagnostics”) containing classes that are used to debug applications and to trace code execution. The namespace allows developers to start system processes, read and write to event logs, and monitor system performance using performance counters.
  • [0062] A globalization namespace 366 (“System.Globalization”) containing classes that define culture-related information, including the language, the country/region, the calendars in use, the format patterns for dates, currency and numbers, and the sort order for strings.
  • [0063] An I/O namespace 368 (“System.IO”) containing the infrastructure pieces to operate with the intput/output of data streams, files, and directories. This namespace includes a model for working with streams of bytes, higher level readers and writers which consume those bytes, various constructions or implementations of the streams (e.g., FileStream and MemoryStream) and, a set of utility classes for working with files and directories.
  • [0064] A net namespace 370 (“System.Net”) providing an extensive set of classes for building network-enabled application, referred to as the Net Class Libraries (NCL). One element to the design of the Net Class Libraries is an extensible, layered approach to exposing networking functionality. The NCL stack contains three basic layers. A base layer (System.Net.Socket) provides access to an interface to TCP/IP, the communications protocol of UNIX networks and the Internet. One example of such an interface is the “WinSock API” from Microsoft Corporation. The next layer is the Transport Protocol classes, which support such transport protocols as TCP and UDP. Developers may write their own protocol classes to provide support for protocols such as IGMP and ICMP. The third layer is the Web request, which provides an abstract factory pattern for the creation of other protocol classes. The NCL provides implementations for Hyper Text Transport Protocol (HTTP).
  • [0065] A reflection namespace (“System.Reflection”) 372 containing types that provide a managed view of loaded types, methods, and fields, with the ability to dynamically create and invoke types.
  • [0066] A resources namespace 374 (“System.Resources”) containing classes and interfaces that allow developers to create, store and manage various culture-specific resources used in an application.
  • [0067] A security namespace 376 (“System.Security”) supporting the underlying structure of the security system, including interfaces, attributes, exceptions, and base classes for permissions.
  • [0068] A service process namespace 378 (“System.ServiceProcess”) containing classes that allow developers to install and run services. Services are long-running executables that run without a user interface. They can be installed to run under a system account that enables them to be started at computer reboot. Services whose implementation is derived from processing in one class can define specific behavior for start, stop, pause, and continue commands, as well as behavior to take when the system shuts down.
  • [0069] A text namespace 380 (“System.Text”) containing classes representing various types of encodings (e.g., ASCII, Unicode, UIF-7, and UIF-8), abstract base classes for converting blocks of characters to and from blocks of bytes, and a helper class that manipulates and formats string objects without creating intermediate instances.
  • [0070] A threading namespace 382 (“System.Threading”) containing classes and interfaces that enable multi-threaded programming. The threading namespace includes a ThreadPool class that manages groups of threads, a Timer class that enables a delegate to be called after a specified amount of time, and a Mutex class for synchronizing mutually-exclusive threads. This namespace also provides classes for thread scheduling, wait notification, and deadlock resolution.
  • [0071] A runtime namespace 384 (“System.Runtime”) containing multiple namespaces concerning runtime features, including an interoperation services namespace 386 (“System.Runtime.InteropServices”) that contains a collection of classes useful for accessing COM objects. The types in the InteropServices namespace fall into the following areas of functionality: attributes, exceptions, managed definitions of COM types, wrappers, type converters, and the Marshal class. The runtime namespace 384 further includes a remoting namespace 388 (“System.Runtime.Remoting”) that contains classes and interfaces allowing developers to create and configure distributed applications. Another namespace within the runtime namespace 384 is a serialization namespace 390 (“System.Runtime.Serialization”) that contains classes used for serializing and deserializing objects. Serialization is the process of converting an object or a graph of objects into a linear sequence of bytes for either storage or transmission to another location.

[0072] The web applications namespace 200 (“System.Web”) defines several additional namespaces, including the services namespace 300 (“System.Web.Services”), a caching namespace 308 (“System.Web.Caching”), a configuration namespace 310 (“System.Web.Configuration”), a UI namespace 312 (“System.Web.UI”), a security namespace 318 (“System.Web.Security”), and a session state namespace 320 (“System.Web.SessionState”). In general, the web applications namespace 200 supplies tools that enable browser-server communication.

[0073] The services namespace 300 contains classes that allow developers to build and use various web services. The services namespace includes a web service class that defines a base class for web services and a web method attribute class that allows a method to be programmatically exposed over the web.

[0074] The UI namespace 312 contains classes that allow a user to create HTML server controls on a web page. These HTML server controls execute on the server and map to standard HTML tags. The UI namespace also contains classes that allow a user to create web server controls on a web page. These web server controls run on the web server and include form controls, such as buttons and text boxes.

[0075] The web applications namespace 200 also includes classes for manipulating cookies, transferring files, handling exception information, and controlling an output cache. Specific details regarding the System.Web namespace are provided below.

System.Web

[0076] Description

[0077] The System.Web namespace supplies classes and interfaces that enable browser/server communication. This namespace includes the HTTPRequest class that provides extensive information about the current HTTP request, the HTTPResponse class that manages HTTP output to the client, and the HTTPServerUtility object that provides access to server-side utilities and processes. System.Web also includes classes for cookie manipulation, file transfer, exception information, and output cache control.

[0078] BeginEventHandler delegate (System.Web)

Description

[0079] EndEventHandler delegate (System.Web)

Description

[0080] HttpWorkerRequest.EndOfSendNotification delegate (System.Web)

Description

[0081] HttpApplication class (System.Web)

Description

[0082] Defines the methods, properties, and events common to all application objects within an ASP.NET application.

[0083] Constructors:

[0084] HttpApplication

[0085] Example Syntax.

[C#] public HttpApplication( ); [C++] public: HttpApplication( ); [VB] Public Sub New( ) [JScript] public function HttpApplication( );

[0086] Properties:

[0087] Application

[0088] [C#] public HttpApplicationState Application {get;} [C++] public: _property HttpApplicationState* get_Application( ); [VB] Public ReadOnly Property Application As HttpApplicationState [JScript] public function get Application( ) : HttpApplicationState;

Description

[0089] Gets a reference to an HTTPApplication state bag instance.

[0090] Context

[C#] public HttpContext Context {get;} [C++] public: _property HttpContext* get_Context( ); [VB] Public ReadOnly Property Context As HttpContext [JScript] public function get Context( ): HttpContext;

Description

[0091] Gets the HTTPRuntime—provided context object that provides access to additional pipeline-module exposed objects.

[0092] Events

[C#] protected EventHandlerList Events {get;} [C++] protected: _property EventHandlerList* get_Events( ); [VB] Protected ReadOnly Property Events As EventHandlerList [JScript] protected function get Events( ): EventHandlerList;

Description

[0093] Modules

[C#] public HttpModuleCollection Modules {get;} [C++] public: _property HttpModuleCollection* get_Modules( ); [VB] Public ReadOnly Property Modules As HttpModuleCollection [JScript] public function get Modules( ): HttpModuleCollection;

Description

[0094] Gets the collection of HTTPModules configured for the current application.

[0095] Request

[C#] public HttpRequest Request {get;} [C++] public: _property HttpRequest* get_Request( ); [VB] Public ReadOnly Property Request As HttpRequest [JScript] public function get Request( ): HttpRequest;

Description

[0096] Gets the intrinsic object that provides access to incoming HttpRequest data.

[0097] Response

[C#] public HttpResponse Response {get;} [C++] public: _property HttpResponse* get_Response( ); [VB] Public ReadOnly Property Response As HttpResponse [JScript] public function get Response( ): HttpResponse;

Description

[0098] The intrinsic object that allows transmission of HttpResponse data to a client.

[0099] Server

[C#] public HttpServerUtility Server {get;} [C++] public: _property HttpServerUtility* get_Server( ); [VB] Public ReadOnly Property Server As HttpServerUtility [JScript] public function get Server( ): HttpServerUtility;

Description

[0100] Gets the intrinsic Server object.

[0101] Session

[C#] public HttpSessionState Session {get;} [C++] public: _property HttpSessionState* get_Session( ); [VB] Public ReadOnly Property Session As HttpSessionState [JScript] public function get Session( ): HttpSessionState;

Description

[0102] Gets the intrinsic Session object that provides access to session data.

[0103] Site

[C#] public ISite Site {get; set;} [C++] public: _property ISite* get_Site( );public: _property void set_Site(ISite*); [VB] Public Property Site As ISite [JScript] public function get Site( ): ISite;public function set Site(ISite);

Description

[0104] User

[C#] public IPrincipal User {get;} [C++] public: _property Iprincipal* get_User( ); [VB] Public ReadOnly Property User As IPrincipal [JScript] public function get User( ): IPrincipal;

Description

[0105] Gets the User intrinsic object.

[C#] public event EventHandler AcquireRequestState; [C++] public: _event EventHandler* AcquireRequesttate; [VB] Public Event AcquireRequesttate As EventHandler

Description

[C#] public event EventHandler AuthenticateRequest; [C++] public: _event EventHandler* AuthenticateRequest; [VB] Public Event AuthenticateRequest As EventHandler

Description

[C#] public event EventHandler AuthorizeRequest; [C++] public: _event EventHandler* AuthorizeRequest; [VB] Public Event AuthorizeRequest As EventHandler

Description

[C#] public event EventHandler BeginRequest; [C++] public: _event EventHandler* BeginRequest; [VB] Public Event BeginRequest As EventHandler

Description

[C#] public event EventHandler Disposed; [C++] public: _sealed _event EventHandler* Disposed; [VB] NotOverridable Public Event Disposed As EventHandler

Description

[C#] public event EventHandler EndRequest; [C++] public: _event EventHandler* EndRequest; [VB] Public Event EndRequest As EventHandler

Description

[C#] public event EventHandler Error; [C++] public: _event EventHandler* Error; [VB] Public Event Error As EventHandler

Description

[C#] public event EventHandler PostRequestHandlerExecute; [C++] public: _event EventHandler* PostRequestHandlerExecute; [VB] Public Event PostRequestHandlerExecute As EventHandler

Description

[C#] public event EventHandler PreRequestHandlerExecute; [C++] public: _event EventHandler* PreRequestHandlerExecute; [VB] Public Event PreRequestHandlerExecute As EventHandler

Description

[C#] public event EventHandler PreSendRequestContent; [C++] public: _event EventHandler* PreSendRequestContent; [VB] Public Event PreSendRequestContent As EventHandler

Description

[C#] public event EventHandler PreSendRequestHeaders; [C++] public: _event EventHandler* PreSendRequestHeaders; [VB] Public Event PreSendRequestHeaders As EventHandler

Description

[C#] public event EventHandler ReleaseRequestState; [C++] public: _event EventHandler* ReleaseRequestState; [VB] Public Event ReleaseRequestState As EventHandler

Description

[C#] public event EventHandler ResolveRequestCache; [C++] public: _event EventHandler* ResolveRequestCache; [VB] Public Event ResolveRequestCache As EventHandler

Description

[C#] public event EventHandler UpdateRequestCache; [C++] public: _event EventHandler* Up dateRequestC ache; [VB] Public Event UpdateRequestCache As EventHandler

Description

[0106] Methods:

[0107] AddOnAcquireRequestStateAsync

[0108] [C#] public void AddOnAcquireRequestStateAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnAcquireRequestStateAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnAcquireRequestStateAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnAcquireRequestStateAsync(bh BeginEventHandler, eh EndEventHandler);

Description

[0109] AddOnAuthenticateRequestAsync

[0110] [C#] public void AddOnAuthenticateRequestAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnAuthenticateRequestAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnAuthenticateRequestAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnAuthenticateRequestAsync(bh BeginEventHandler, eh EndEventHandler);

Description

[0111] AddOnAuthorizeRequestAsync

[0112] [C#] public void AddOnAuthorizeRequestAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnAuthorizeRequestAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnAuthorizeRequestAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnAuthorizeRequestAsync(bh: BeginEventHandler, eh EndEventHandler);

Description

[0113] AddOnBeginRequestAsync

[0114] [C#] public void AddOnBeginRequestAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnBeginRequestAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnBeginRequestAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnBeginRequestAsync(bh: BeginEventHandler, eh: EndEventHandler);

Description

[0115] AddOnEndRequestAsync

[0116] [C#] public void AddOnEndRequestAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnEndRequestAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnEndRequestAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnEndRequestAsync(bh: BeginEventHandler, eh: EndEventHandler);

Description

[0117] AddOnPostRequestHandlerExecuteAsync

[0118] [C#] public void AddOnPostRequestHandlerExecuteAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnPostRequestHandlerExecuteAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnPostRequestHandlerExecuteAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnPostRequestHandlerExecuteAsync(bh BeginEventHandler, eh EndEventHandler);

Description

[0119] AddOnPreRequestHandlerExecuteAsync

[0120] [C#] public void AddOnPreRequestHandlerExecuteAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnPreRequestHandlerExecuteAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnPreRequestHandlerExecuteAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnPreRequestHandlerExecuteAsync(bh: BeginEventHandler, eh: EndEventHandler);

Description

[0121] AddOnReleaseRequestStateAsync

[0122] [C#] public void AddOnReleaseRequestStateAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnReleaseRequestStateAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnReleaseRequestStateAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnReleaseRequestStateAsync(bh: BeginEventHandler, eh: EndEventHandler);

Description

[0123] AddOnResolveRequestCacheAsync

[0124] [C#] public void AddOnResolveRequestCacheAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnResolveRequestCacheAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnResolveRequestCacheAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnResolveRequestCacheAsync(bh: BeginEventHandler, eh: EndEventHandler);

Description

[0125] AddOnUpdateRequestCacheAsync

[0126] [C#] public void AddOnUpdateRequestCacheAsync(BeginEventHandler bh, EndEventHandler eh); [C++] public: void AddOnUpdateRequestCacheAsync(BeginEventHandler* bh, EndEventHandler* eh); [VB] Public Sub AddOnUpdateRequestCacheAsync(ByVal bh As BeginEventHandler, ByVal eh As EndEventHandler) [JScript] public function AddOnUpdateRequestCacheAsync(bh: BeginEventHandler, eh: EndEventHandler);

Description

[0127] CompleteRequest

[C#] public void CompleteRequest( ); [C++] public: void CompleteRequest( ); [VB] Public Sub CompleteRequest( ) [JScript] public function CompleteRequest( );

Description

[0128] Dispose

[C#] public virtual void Dispose( ); [C++] public: virtual void Dispose( ); [VB] Overridable Public Sub Dispose( ) [JScript] public function Dispose( );

Description

[0129] Cleans up the instance variables of an HttpModule.

[0130] The System.Web.HttpApplication.Request, System.Web.HttpApplication.Response, System.Web.HttpApplication.Session and System.Web.HttpApplication.Application properties are not available for use at the time System.Web.HttpApplication.Dispose is executed.

[0131] GetVaryByCustomString

[0132] [C#] public virtual string GetVaryByCustomString(HttpContext context, string custom); [C++] public: virtual String* GetVaryByCustomString(HttpContext* context, String* custom); [VB] Overridable Public Function GetVaryByCustomString(ByVal context As HttpContext, ByVal custom As String) As String [JScript] public function GetVaryByCustomString(context: HttpContext, custom: String) String;

Description

[0133] Init

[C#] public virtual void Init( ); [C++] public: virtual void Init( ); [VB] Overridable Public Sub Init( ) [JScript] public function Init( );

Description

[0134] Initializes HttpModule instance variables and register event handlers with the hosting Application.

[0135] IHttpAsyncHandler.BeginProcessRequest

[0136] [C#] IAsyncResult IHttpAsyncHandler.BeginProcessRequest(HttpContext context, AsyncCallback cb, object extraData); [C++] IAsyncResult* IHttpAsyncHandler::BeginProcessRequest(HttpContext* context, AsyncCallback* cb, Object* extraData); [VB] Function BeginProcessRequest(ByVal context As HttpContext, ByVal cb As AsyncCallback, ByVal extraData As Object) As IAsyncResult Implements IHttpAsyncHandler.BeginProcessRequest [JScript] function IHttpAsyncHandler.BeginProcessRequest(context: HttpContext, cb: AsyncCallback, extraData: Object): IAsyncResult;

[0137] IHttpAsyncHandler.EndProcessRequest

[0138] [C#] void IHttpAsyncHandler.EndProcessRequest(IAsyncResult result); [C++] void IHttpAsyncHandler::EndProcessRequest(IAsyncResult* result); [VB] Sub EndProcessRequest(ByVal result As IAsyncResult) Implements IHttpAsyncHandler.EndProcessRequest [JScript] function IHttpAsyncHandler.EndProcessRequest(result: IAsyncResult);

[0139] IHttpHandler.ProcessRequest

[0140] [C#] void IHttpHandler.ProcessRequest(HttpContext context); [C++] void IHttpHandler: ProcessRequest(HttpContext* context); [VB] Sub ProcessRequest(ByVal context As HttpContext) Implements IHttpHandler.ProcessRequest [JScript] function IHttpHandler.ProcessRequest(context: HttpContext);

[0141] HttpApplicationState class (System.Web)

[0142] ToString

Description

[0143] Enables sharing of global information across multiple sessions and requests within an ASP.NET application.

[0144] An ASP.NET application is the sum of all files, pages, handlers, modules, and code within the scope of a virtual directory and its subdirectories on a single web server.

[0145] AllKeys

[0146] ToString

[C#] public string[ ] AllKeys {get;} [C++] public: property String* get AllKeys( ); [VB] Public ReadOnly Property AllKeys As String ( ) [JScript] public function get AllKeys( ): String[ ];

Description

[0147] Gets the access keys in the System.Web.HttpApplicationState collection.

[0148] Contents

[0149] ToString

[C#] public HttpApplicationState Contents {get;} [C++] public: _property HttpApplicationState* get_Contents( ); [VB] Public ReadOnly Property Contents As HttpApplicationState [JScript] public function get Contents( ): HttpApplicationState;

Description

[0150] Gets a reference to the System.Web.HttpApplicationState object.

[0151] This property provides compatibility with earlier versions of ASP.

[0152] Count

[0153] ToString

[C#] public override int Count {get;} [C++] public: _property virtual int get_Count( ); [VB] Overrides Public ReadOnly Property Count As Integer [JScript] public function get Count( ): int;

Description

[0154] Gets the number of objects in the System.Web.HttpApplicationState collection.

[0155] IsReadOnly

[0156] Item

[0157] ToString

[0158] System.Web.HttpApplicationState

Description

[0159] Gets the value of a single System.Web.HttpApplicationState object by name. The name of the object in the collection.

[0160] Item

[0161] ToString

[C#] public object this[int index] {get;} [C++] public: _property Object* get_Item(int index); [VB] Public Default ReadOnly Property Item(ByVal index As Integer) As Object [JScript] returnValue =HttpApplicationStateObject.Item(index);

Description

[0162] Gets a single System.Web.HttpApplicationState object by index. The numerical index of the object in the collection.

[0163] Keys

[0164] StaticObjects

[0165] ToString

Description

[0166] Gets all objects declared via an tag within the ASP.NET application.

[0167] Application objects are defined in the Global.asax file.

[0168] Add

[C#] public void Add(string name, object value); [C++] public: void Add(String* name, Object* value); [VB] Public Sub Add(ByVal name As String, ByVal value As Object) [JScript] public function Add(name: String, value: Object);

Description

[0169] Adds a new object to the System.Web.HttpApplicationState collection. The name of the object to be added to the collection. The value of the object.

[0170] Clear

[C#] public void Clear( ); [C++] public: void Clear( ); [VB] Public Sub Clear( ) [JScript] public function Clear( );

Description

[0171] Removes all objects from an System.Web.HttpApplicationState collection.

[0172] Get

[C#] public object Get(int index); [C++] public: Object* Get(int index); [VB] Public Function Get(ByVal index As Integer) As Object [JScript] public function Get(index: int): Object;

Description

[0173] Gets an System.Web.HttpApplicationState object by numerical index.

Return Value: The object referenced by index. The index of the application state object.

[0174] Get

[0175] [C#] public object Get(string name); [C++] public: Object* Get(String* name); [VB] Public Function Get(ByVal name As String) As Object [JScript] public function Get(name: String): Object; Gets an System.Web.HttpApplicationState object by name or index.

Description

[0176] Gets an System.Web.HttpApplicationState object by name.

Return Value: The object referenced by name.

[0177] The following example returns an object named MyAppVarl from the System.Web.HttpApplicationState collection of the intrinsic System.Web.HttpContext.Application object and copies it to a new object variable. The name of the object.

[0178] GetKey

[C#] public string GetKey(int index); [C++] public: String* GetKey(int index); [VB] Public Function GetKey(ByVal index As Integer) As String [JScript] public function GetKey(index: int): String;

Description

[0179] Gets an System.Web.HttpApplicationState object name by index.

Return Value: The name under which the application state object was saved. The index of the application state object.

[0180] Lock

[C#] public void Lock( ); [C++] public: void Lock( ); [VB] Public Sub Lock( ) [JScript] public function Lock( );

Description

[0181] Locks access to an System.Web.HttpApplicationState variable to facilitate access synchronization.

[0182] Remove

[C#] public void Remove(string name); [C++] public: void Remove(String* name); [VB] Public Sub Remove(ByVal name As String) [JScript] public function Remove(name: String);

Description

[0183] Removes the named object from an System.Web.HttpApplicationState collection. The name of the object to be removed from the collection.

[0184] RemoveAll

[C#] public void RemoveAll( ); [C++] public: void RemoveAll( ); [VB] Public Sub RemoveAll( ) [JScript] public function RemoveAll( );

Description

[0185] Removes all objects from an System.Web.HttpApplicationState collection.

[0186] System.Web.HttpApplicationState.RemoveAll is an internal call to System.Web.IHttpApplicationState.Clear.

[0187] RemoveAt

[C#] public void RemoveAt(int index); [C++] public: void RemoveAt(int index); [VB] Public Sub RemoveAt(ByVal index As Integer) [JScript] public function RemoveAt(index: int); Removes an object from the application state collection by name.

[0188] Set

[C#] public void Set(string name, object value); [C++] public: void Set(String* name, Object* value); [VB] Public Sub Set(ByVal name As String, ByVal value As Object) [JScript] public function Set(name: String, value: Object);

Description

[0189] Updates the value of an object in an System.Web.HttpApplicationState collection. The name of the object to be updated. The updated value of the object.

[0190] UnLock

[C#] public void UnLock( ); [C++] public: void UnLock( ); [VB] Public Sub UnLock( ) [JScript] public function UnLock( );

Description

[0191] Unlocks access to an System.Web.HttpApplicationState variable to facilitate access synchronization.

[0192] HttpBrowserCapabilities class (System.Web)

[0193] UnLock

Description

[0194] Enables the server to gather information on the capabilities of the browser that is running on the client.

[0195] System.Web.HttpBrowserCapabilities properties are accessible through the System.Web.HttpRequest.Browser property of ASP.NET's intrinsic System.Web.HttpContext.Request object.

[0196] HttpBrowserCapabilities

[0197] Example Syntax:

[0198] UnLock

[C#] public HttpBrowserCapabilities( ); [C++] public: HttpBrowserCapabilities( ); [VB] Public Sub New( ) [JScript] public function HttpBrowserCapabilities( );

[0199] ActiveXControls

[0200] UnLock

[C#] public bool ActiveXControls {get;} [C++] public: _property bool get_ActiveXControls( ); [VB] Public ReadOnly Property ActiveXControls As Boolean [JScript] public function get ActiveXControls( ): Boolean;

Description

[0201] Gets a value indicating whether the client browser supports ActiveX controls.

[0202] AOL

[0203] UnLock

[C#] public bool AOL {get;} [C++] public: _property bool get_AOL( ); [VB] Public ReadOnly Property AOL As Boolean [JScript] public function get AOL( ): Boolean;

Description

[0204] Gets a value indicating whether the client is an America Online (AOL) browser.

[0205] BackgroundSounds

[0206] UnLock

[C#] public bool BackgroundSounds {get;} [C++] public: _property bool get_BackgroundSounds( ); [VB] Public ReadOnly Property BackgroundSounds As Boolean [JScript] public function get BackgroundSounds( ): Boolean;

Description

[0207] Gets a value indicating whether the client browser supports background sounds.

[0208] Beta

[0209] UnLock

[C#] public bool Beta {get;} [C++] public: _property bool get_Beta( ); [VB] Public ReadOnly Property Beta As Boolean [JScript] public function get Beta( ): Boolean;

Description

[0210] Gets a value indicating whether the browser is a beta release.

[0211] Browser

[0212] UnLock

[C#] public string Browser {get;} [C++] public: _property String* get_Browser( ); [VB] Public ReadOnly Property Browser As String [JScript] public function get Browser( ): String;

Description

[0213] Gets the browser string (if any) that was transmitted in the User-Agent header.

[0214] CDF

[0215] UnLock

[C#] public bool CDF {get;} [C++] public: _property bool get_CDF( ); [VB] Public ReadOnly Property CDF As Boolean [JScript] public function get CDF( ): Boolean;

Description

[0216] Gets a value indicating whether the client browser supports Channel Definition Format (CDF) for webcasting.

[0217] ClrVersion

[0218] UnLock

[C#] public Version ClrVersion {get;} [C++] public: _property Version* get_ClrVersion( ); [VB] Public ReadOnly Property ClrVersion As Version [JScript] public function get ClrVersion( ): Version;

Description

[0219] Gets the version number of the NET common language runtime that the client browser supports.

[0220] If no common language runtime version is specified, the property value is 0, 0,−1,−1.

[0221] Cookies

[0222] UnLock

[C#] public bool Cookies {get;} [C++] public: _property bool get_Cookies( ); [VB] Public ReadOnly Property Cookies As Boolean [JScript] public function get Cookies( ): Boolean;

Description

[0223] Gets a value indicating whether the client browser supports cookies.

[0224] Crawler

[0225] UnLock

[C#] public bool Crawler {get;} [C++] public: _property bool get_Crawler( ); [VB] Public ReadOnly Property Crawler As Boolean [JScript] public function get Crawler( ): Boolean;

Description

[0226] Gets a value indicating whether the client browser is a Web crawler search engine.

[0227] EcmaScriptVersion

[0228] UnLock

[C#] public Version EcmaScriptVersion {get;} [C++] public: _property Version* get_EcmaScriptVersion( ); [VB] Public ReadOnly Property EcmaScriptVersion As Version [JScript] public function get EcmaScriptVersion( ): Version;

Description

[0229] Gets the version number of ECMA script that the client browser supports.

[0230] The European Computer Manufacturer's Association develops standards for information and communication systems. For more information, see ECMA's official Web site at http://www.ecma.ch.

[0231] Frames

[0232] UnLock

[C#] public bool Frames {get;} [C++] public: _property bool get_Frames( ); [VB] Public ReadOnly Property Frames As Boolean [JScript] public function get Frames( ): Boolean;

Description

[0233] Gets a value indicating whether the client browser supports HTML frames.

[0234] Item

[0235] JavaApplets

[0236] UnLock

Description

[0237] Gets a value indicating whether the client browser supports Java applets.

[0238] JavaScript

[0239] UnLock

[C#] public bool JavaScript {get;} [C++] public: _property bool get_JavaScript( ); [VB] Public ReadOnly Property JavaScript As Boolean [JScript] public function get JavaScript( ): Boolean;

Description

[0240] Gets a value indicating whether the client browser supports JavaScript.

[0241] MajorVersion

[0242] UnLock

[C#] public int MajorVersion {get;} [C++] public: _property int get_MajorVersion( ); [VB] Public ReadOnly Property MajorVersion As Integer [JScript] public function get MajorVersion( ): int;

Description

[0243] Gets the major (that is, integer) version number of the client browser.

[0244] MinorVersion

[0245] UnLock

[C#] public double MinorVersion {get;} [C++] public: _property double get_MinorVersion( ); [VB] Public ReadOnly Property MinorVersion As Double [JScript] public function get MinorVersion( ): double;

Description

[0246] Gets the minor (that is, decimal) version number of the client browser.

[0247] MSDomVersion

[0248] UnLock

[C#] public Version MSDomVersion {get;} [C++] public: _property Version* get_MSDomVersion( ); [VB] Public ReadOnly Property MSDomVersion As Version [JScript] public function get MSDomVersion( ): Version;

Description

[0249] Gets the version of Microsoft HTML (MSHTML) Document Object Model (DOM) that the client browser supports.

[0250] Platform

[0251] UnLock

[C#] public string Platform {get;} [C++] public: _property String* get_Platform( ); [VB] Public ReadOnly Property Platform As String [JScript] public function get Platform( ): String;

Description

[0252] Gets the name of the platform that the client uses.

[0253] Some possible Platform values are: Unknown, Win95, Win98, WinNT (which includes Windows 2000), Win16, WinCE, Mac68K, MacPPC, UNIX, and WebTV.

[0254] Tables

[0255] UnLock

[C#] public bool Tables {get;} [C++] public: _property bool get_Tables( ); [VB] Public ReadOnly Property Tables As Boolean [JScript] public function get Tables( ): Boolean;

Description

[0256] Gets a value indicating whether the client browser supports HTML tables.

[0257] TagWriter

[0258] UnLock

[C#] public Type TagWriter {get;} [C++] public: _property Type* get_TagWriter( ); [VB] Public ReadOnly Property TagWriter As Type [JScript] public function get TagWriter( ): Type;

Description

[0259] Type

[0260] UnLock

[C#] public string Type {get;} [C++] public: _property String* get_Type( ); [VB] Public ReadOnly Property Type As String [JScript] public function get Type( ): String;

Description

[0261] Gets the name and major (that is, integer) version number of the client browser.

[0262] VBScript

[0263] UnLock

[C#] public bool VBScript {get;} [C++] public: _property bool get_VBScript( ); [VB] Public ReadOnly Property VBScript As Boolean [JScript] public function get VBScript( ): Boolean;

Description

[0264] Gets a value indicating whether the client browser supports VBScript.

[0265] Version

[0266] UnLock

[C#] public string Version {get;} [C++] public: _property String* get_Version( ); [VB] Public ReadOnly Property Version As String [JScript] public function get Version( ): String;

Description

[0267] Gets the full (integer and decimal) version number of the client browser.

[0268] W3CDomVersion

[0269] UnLock

[C#] public Version W3CDomVersion {get;} [C++] public: _property Version* get_W3CDomVersion( ); [VB] Public ReadOnly Property W3CDomVersion As Version [JScript] public function get W3CDomVersion( ): Version;

Description

[0270] Gets the version of the World Wide Web Consortium (W3C) XML Document Object Model (DOM) that the client browser supports.

[0271] Win16

[0272] UnLock

[C#] public bool Win16 {get;} [C++] public: _property bool get_Win16( ); [VB] Public ReadOnly Property Win16 As Boolean [JScript] public function get Win16( ): Boolean;

Description

[0273] Gets a value indicating whether the client is a Win16-based machine.

[0274] Win32

[0275] UnLock

[C#] public bool Win32 {get;} [C++] public: _property bool get_Win32( ); [VB] Public ReadOnly Property Win32 As Boolean [JScript] public function get Win32( ): Boolean;

Description

[0276] Gets a value indicating whether the client is a Win32-based machine.

[0277] HttpCacheability enumeration (System.Web)

[0278] ToString

Description

[0279] Provides enumerated values that are used to set the Cache-Control HTTP 11 header.

[0280] ToString

[C#] public const HttpCacheability NoCache; [C++] public: const HttpCacheability NoCache; [VB] Public Const NoCache As HttpCacheability [JScript] public var NoCache: HttpCacheability;

Description

[0281] Sets the Cache-Control: no-cache header. Without a field name, the directive applies to the entire request and a shared (proxy server) cache must force a successful revalidation with the origin Web server before satisfying the request. With a field name, the directive applies only to the named field; the rest of the response may be supplied from a shared cache.

[0282] ToString

[C#] public const HttpCacheability Private; [C++] public: const HttpCacheability Private; [VB] Public Const Private As HttpCacheability [JScript] public var Private: HttpCacheability;

Description

[0283] Default value. Sets Cache-Control: private to specify that the response is cacheable only on the client and not by shared (proxy server) caches.

[0284] ToString

[C#] public const HttpCacheability Public; [C++]public: const HttpCacheability Public; [VB] Public Const Public As HttpCacheability [JScript] public var Public: HttpCacheability;

Description

[0285] Sets Cache-Control: public to specify that the response is cacheable by clients and shared (proxy) caches.

[0286] ToString

[C#] public const HttpCacheability Server; [C++] public: const HttpCacheability Server; [VB] Public Const Server As HttpCacheability [JScript] public var Server: HttpCacheability;

Description

[0287] Specifies that the response is cached only at the origin server. Similar to the NoCache option. Clients receive a Cache-Control: no-cache directive but the document is cached on the origin server.

[0288] HttpCachePolicy class (System.Web)

[0289] ToString

Description

[0290] Contains methods for setting cache-specific HTTP headers and for controlling the ASP.NET page output cache.

[0291] For background information on HTTP headers and controlling caching, see the document RFC 2616: Hypertext Transfer Protocol—HTTP/1.1, available on the World Wide Web Consortium's site at http://www.w3c.org.

[0292] VaryByHeaders

[0293] ToString

[0294] [C#] public HttpCacheVaryByHeaders VaryByHeaders {get;} [C++] public: _property HttpCacheVaryByHeaders* get_VaryByHeaders( ); [VB] Public ReadOnly Property VaryByHeaders As HttpCacheVaryByHeaders [JScript] public function get VaryByHeaders( ): HttpCacheVaryByHeaders;

Description

[0295] Gets the list of all HTTP headers that will be used to vary cache output.

[0296] When a cached item has several vary headers, a separate version of the requested document is available from the cache for each HTTP header type.

[0297] VaryByParams

[0298] ToString

[0299] [C#] public HttpCacheVaryByParams VaryByParams {get;} [C++] public: _property HttpCacheVaryByParams* get_VaryByParams( ); [VB] Public ReadOnly Property VaryByParams As HttpCacheVaryByParams [JScript] public function get VaryByParams( ): HttpCacheVaryByParams;

Description

[0300] Gets the list of parameters received by a GET (querystring) or POST (in the body of the HTTP request) that affect caching.

[0301] For each named parameter in VaryByParams a separate version of the requested document is available from the cache, the version varying by the parameter's value.

[0302] AddValidationCallback

[0303] [C#] public void AddValidationCallback(HttpCacheValidateHandler handler, object data); [C++] public: void AddValidationCallback(HttpCacheValidateHandler* handler, Object* data); [VB] Public Sub AddValidationCallback(ByVal handler As HttpCacheValidateHandler, ByVal data As Object) [JScript] public function AddValidationCallback(handler: HttpCacheValidateHandler, data: Object);

Description

[0304] Registers a validation callback for the current response.

[0305] AddValidationCallback provides a mechanism to programmatically check the validity of a item in the cache before the item is returned from the cache. The System.Web.HttpCacheValidateHandler value. The arbitrary user-supplied data that is passed back to the AddValidationCallback delegate.

[0306] AppendCacheExtension

[C#] public void AppendCacheExtension(string extension); [C++] public: void AppendCacheExtension(String* extension); [VB] Public Sub AppendCacheExtension(ByVal extension As String) [JScript] public function AppendCacheExtension(extension: String);

Description

[0307] Appends the specified text to the Cache-Control HTTP header.

[0308] If the browser does not recognize cache control directives or extensions, the browser must ignore the unrecognized terms. For more information, see the document RFC 2616: Hypertext Transfer Protocol—HTTP/1.1, available on the World Wide Web Consortium's site at http://www.w3c.org. The text to append to the Cache-Control header.

[0309] SetCacheability

[0310] [C#] public void SetCacheability(HttpCacheability cacheability); [C++] public: void SetCacheability(HttpCacheability cacheability); [VB] Public Sub SetCacheability(ByVal cacheability As HttpCacheability) [JScript] public function SetCacheability(cacheability: HttpCacheability); Sets the Cache-Control HTTP header. The Cache-Control HTTP header controls how documents are to be cached on the network.

Description

[0311] Sets the Cache-Control header to one of the values of System.Web.HttpCacheability. An System.Web.HttpCacheability enumeration value.

[0312] SetCacheability

[0313] [C#] public void SetCacheability(HttpCacheability cacheability, string field); [C++] public: void SetCacheability(HttpCacheability cacheability, String* field); [VB] Public Sub SetCacheability(ByVal cacheability As HttpCacheability, ByVal field As String) [JScript] public function SetCacheability(cacheability: HttpCacheability, field: String);

Description

[0314] Sets the Cache-Control header to one of the values of System.Web.HttpCacheability and appends an extension to the directive.

[0315] The field name extension is valid only when used with the private or no-cache directives. For more information, see the document RFC 2616: Hypertext Transfer Protocol—HTTP/1.1, available on the World Wide Web Consortium's site at http://www.w3c.org. The System.Web.HttpCacheability enumeration value to set the header to. The cache control extension to add to the header.

[0316] SetETag

[C#] public void SetETag(string etag); [C++] public: void SetETag(String* etag); [VB] Public Sub SetETag(ByVal etag As String) [JScript] public function SetETag(etag: String);

Description

[0317] Sets the ETag HTTP header to the specified string.

[0318] The ETag header is a unique identifier for a specific version of a document. Once an ETag header is set, subsequent attempts to set it will fail and an exception will be thrown. The text to use for the ETag header.

[0319] SetETagFromFileDependencies

[C#] public void SetETagFromFileDependencies( ); [C++] public: void SetETagFromFileDependencies( ); [VB] Public Sub SetETagFromFileDependencies( ) [JScript] public function SetETagFromFileDependencies( );

Description

[0320] Sets the ETag HTTP header based on the time stamps of the handler's file dependencies.

[0321] SetEtagFromFileDependencies sets the ETag header by retrieving the last modified time stamps of all files on which the handler is dependent, combining all file names and time stamps into a single string, then hashing that string into a single digest that is used as the ETag.

[0322] SetExpires

[C#] public void SetExpires(DateTime date); [C++] public: Void SetExpires(DateTime date); [VB] Public Sub SetExpires(ByVal date As DateTime) [JScript] public function SetExpires(date: DateTime);

Description

[0323] Sets the Expires HTTP header to an absolute date and time.

[0324] This method will fail if the expiration date violates the principle of restrictiveness. The absolute System.DateTime value to set the Expiresheader to.

[0325] SetLastModified

[C#] public void SetLastModified(DateTime date); [C++] public: void SetLastModified(DateTime date); [VB] Public Sub SetLastModified(ByVal date As DateTime) [JScript] public function SetLastModified(date: DateTime);

Description

[0326] Sets the Last-Modified HTTP header to the System.DateTime value supplied.

[0327] The Last-Modified HTTP header time stamps the document with the DateTime value indicating when the document was last modified. The new System.DateTime value for the Last-Modified header.

[0328] SetLastModifiedFromFileDependencies

[C#] public void SetLastModifiedFromFileDependencies( ); [C++] Public: void SetLastModifiedFromFileDependencies( ); [VB] Public Sub SetLastModifiedFromFileDependencies( ) [JScript] public function SetLastModifiedFromFileDependencies( );

Description

[0329] Sets the Last-Modified HTTP header based on the time stamps of the handler's file dependencies.

[0330] SetMaxAge

[C#] public void SetMaxAge(TimeSpan delta); [C++] public: void SetMaxAge(TimeSpan delta); [VB] Public Sub SetMaxAge(ByVal delta As TimeSpan) [JScript] public function SetMaxAge(delta: TimeSpan);

Description

[0331] Sets the Cache-Control: max-age HTTP header based on the specified time span.

[0332] Max-age is the maximum absolute time a document is allowed to exist before being considered stale. The time span used to set the Cache-Control: max-age header.

[0333] SetNoServerCaching

[C#] public void SetNoServerCaching( ); [C++] public: void SetNoServerCaching( ); [VB] Public Sub SetNoServerCaching( ) [JScript] public function SetNoServerCaching( );

Description

[0334] Stops all origin-server caching for the current response.

[0335] Explicitly denies caching of the document on the origin-server. Once set, all requests for the document are fully processed. When this method is invoked, caching cannot be reenabled for the current response.

[0336] SetNoStore

[C#] public void SetNoStore( ); [C++] public: void SetNoStore( ); [VB] Public Sub SetNoStore( ) [JScript] public function SetNoStore( );

Description

[0337] Sets the Cache-Control: no-store directive.

[0338] SetNoTransforms

[C#] public void SetNoTransforms( ); [C++] public: void SetNoTransforms( ); [VB] Public Sub SetNoTransforms( ) [JScript] public function SetNoTransforms( );

Description

[0339] Sets the CacheControl: no-transform directive.

[0340] The no-transform CacheControl setting instructs network caching applications to not modify the document.

[0341] SetProxyMaxAge

[C#] public void SetProxyMaxAge(TimeSpan delta); [C++] public: void SetProxyMaxAge(TimeSpan delta); [VB] Public Sub SetProxyMaxAge(ByVal delta As TimeSpan) [JScript] public function SetProxyMaxAge(delta: TimeSpan);

Description

[0342] Sets the Cache-Control: s-maxage HTTP header based on the specified time span.

[0343] System.Web.HttpCachePolicy.SetProxyMaxAge(System.TimeSpan) does not use sliding expiration and will fail if the expiration date violates the principle of restrictiveness. The time span used to set the Cache-Control: s-maxage header.

[0344] SetRevalidation

[0345] [C#] public void SetRevalidation(HttpCacheRevalidation revalidation); [C++] public: void SetRevalidation(HttpCacheRevalidation revalidation); [VB] Public Sub SetRevalidation(ByVal revalidation As HttpCacheRevalidation) [JScript] public function SetRevalidation(revalidation: HttpCacheRevalidation);

Description

[0346] Sets the Cache-Control HTTP header to either the must-revalidate or the proxy-revalidate directives based on the supplied enumeration value.

[0347] The default is to send neither directive in a header unless explicitly specified by this method. The System.Web.HttpCacheRevalidation enumeration value to set the Cache-Control header to.

[0348] SetSlidingExpiration

[C#] public void SetSlidingExpiration(bool slide); [C++] public: void SetSlidingExpiration(bool slide); [VB] Public Sub SetSlidingExpiration(ByVal slide As Boolean) [JScript] public function SetSlidingExpiration(slide: Boolean);

Description

[0349] Sets cache expiration to sliding.

[0350] When cache expiration is set to sliding, the Cache-Control HTTP header will be renewed with each response. This expiration mode is identical to the IIS configuration option to add an expiration header to all output set relative to the current time. true or false.

[0351] SetValidUntilExpires

[0352] [C#] public void SetValidUntilExpires(bool validUntilExpires); [C++] public: void SetValidUntilExpires(bool validUntilExpires); [VB] Public Sub SetValidUntilExpires(ByVal validUntilExpires As Boolean) [JScript] public function SetValidUntilExpires(validUntilExpires: Boolean);

Description

[0353] SetVaryByCustom

[C#] public void SetVaryByCustom(string custom); [C++] public: void SetVaryByCustom(String* custom); [VB] Public Sub SetVaryByCustom(ByVal custom As String) [JScript] public function SetVaryByCustom(custom: String);

Description

[0354] Sets the Vary HTTP header to the specified text string. The text to set the Vary header to.

[0355] HttpCacheRevalidation enumeration (System.Web)

[0356] ToString

Description

[0357] Provides enumerated values that are used to set revalidation-specific Cache-Control HTTP headers.

[0358] ToString

[C#] public const HttpCacheRevalidation AllCaches; [C++] public: const HttpCacheRevalidation AllCaches; [VB] Public Const AllCaches As HttpCacheRevalidation [JScript] public var AllCaches: HttpCacheRevalidation;

Description

[0359] Sets the Cache-Control: must-revalidate HTTP header.

[0360] ToString

[C#] public const HttpCacheRevalidation None; [C++] public: const HttpCacheRevalidation None; [VB] Public Const None As HttpCacheRevalidation [JScript] public var None: HttpCacheRevalidation;

Description

[0361] Default value. If this value is set, no cache-revalidation directive is sent.

[0362] ToString

[C#] public const HttpCacheRevalidation ProxyCaches; [C++] public: const HttpCacheRevalidation ProxyCaches; [VB] Public Const ProxyCaches As HttpCacheRevalidation [JScript] public var ProxyCaches: HttpCacheRevalidation;

Description

[0363] Sets the Cache-Control: proxy-revalidate HTTP header.

[0364] HttpCacheValidateHandler delegate (System.Web)

[0365] ToString

Description

[0366] Delegate method that is called when a cached item is validated. Cache 11 items invalidated within the method are treated as cache misses. The System.Web.HttpContext object containing information about the current request. User-supplied data used to validate the cached item. A System.Web.HttpValidationStatus enumeration value.

[0367] If any handler invalidates the cached item, the item is evicted from the cache and the request is handled as a cache miss.

[0368] HttpCacheVaryByHeaders class (System.Web)

[0369] ToString

Description

[0370] Provides a type-safe way to set the Vary HTTP header.

[0371] The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request.

[0372] AcceptTypes

[0373] ToString

[0374] [C#] public bool AcceptTypes {get; set;} [C++] public: _property bool get_AcceptTypes( );public: _property void set_AcceptTypes(bool); [VB] Public Property AcceptTypes As Boolean [JScript] public function get AcceptTypes( ): Boolean;public function set AcceptTypes(Boolean);

Description

[0375] Gets or sets a value indicating whether the origin server adds the Accept field to the Vary HTTP header.

[0376] The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The Accept field specifies that the server selects the response based on the media types acceptable to the client.

[0377] Item

[0378] ToString

[0379] [C#] public bool this[string header] {get; set;} [C++] public: _property bool get_Item(String* header);public: _property void set_Item(String* header, bool); [VB] Public Default Property Item(ByVal header As String) As Boolean [JScript] returnValue=HttpCacheVaryByHeadersObject.Item(header);HttpCacheVaryByHeadersObject.Item(header)=returnValue;

Description

[0380] Gets or sets a value indicating whether the origin server should add a custom field to the Vary HTTP header.

[0381] The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The name of the custom header.

[0382] UserAgent

[0383] ToString

[0384] [C#] public bool UserAgent {get; set;} [C++] public: _property bool get_UserAgent( );public: _property void set_UserAgent(bool); [VB] Public Property UserAgent As Boolean [JScript] public function get UserAgent( ): Boolean;public function set UserAgent(Boolean);

Description

[0385] Gets or sets a value indicating whether the origin server adds the User-Agent field to the Vary HTTP header.

[0386] The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The User-Agent field specifies that the server selects the response based on the type of client user-agent.

[0387] UserCharSet

[0388] ToString

[0389] [C#] public bool UserCharSet {get; set;} [C++] public: _property bool get_UserCharSet( );public: _property void set_UserCharSet(bool); [VB] Public Property UserCharSet As Boolean [JScript] public function get UserCharSet( ): Boolean;public function set 1I UserCharSet(Boolean);

Description

[0390] Gets or sets a value indicating whether the origin server should add the Accept-Charset field to the Vary HTTP header.

[0391] The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The Accept-CharSet field specifies that the server selects the response based on the client's character set.

[0392] UserLanguage

[0393] ToString

[0394] [C#] public bool UserLanguage {get; set;} [C++] public: _property bool get_UserLanguage( );public: _property void set_UserLanguage(bool); [VB] Public Property UserLanguage As Boolean [JScript] public function get UserLanguage( ): Boolean;public function set UserLanguage(Boolean);

Description

[0395] Gets or sets a value indicating whether the origin server adds the Accept-Language field to the Vary HTTP header.

[0396] The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The Accept-Language field specifies that the server selects the response based on languages acceptable to the client.

[0397] VaryByUnspecifiedParameters

[C#] public void VaryByUnspecifiedParameters( ); [C++ public: void VaryByUnspecifiedParameters( ); [VB] Public Sub VaryByUnspecifiedParameters( ) [JScript] public function VaryByUnspecifiedParameters( );

Description

[0398] Sets the Vary HTTP header to the value * (an asterisk) and causes all other Vary header information to be dropped.

[0399] The Vary header indicates the request-header fields that the server uses to determine which of multiple cached responses is sent in response to a client request. The * field specifies that the server selects the response based on parameters not specified in request headers (for example, the network address of the client).

[0400] HttpCacheVaryByParams class (System.Web)

[0401] VaryByUnspecifiedParameters

Description

[0402] Indicates that a cache should contain multiple representations (cached responses) for a particular URI. This class is an encapsulation that provides a type-safe way to set the Vary HTTP header.

[0403] For more information on HTTP cache control headers, see RFC 2616: Hypertext Transfer Protocol—HTTP/1.1, available on the World Wide Web Consortium's Web site at http://www.w3c.org. See section 14, “Header Field Definitions”, for complete details.

[0404] IgnoreParams

[0405] VaryByUnspecifiedParameters

[0406] [C#] public bool IgnoreParams {get; set;} [C++] public: _property bool get_IgnoreParams( );public: _property void set_IgnoreParams(bool); [VB] Public Property IgnoreParams As Boolean [JScript] public function get IgnoreParams( ): Boolean;public function set IgnoreParams(Boolean);

Description

[0407] Gets or sets a value indicating whether HTTP header cache control parameters are ignored.

[0408] Item

[0409] VaryByUnspecifiedParameters

[0410] [C#] public bool this[string header] {get; set;} [C++] public: _property bool get_Item(String* header);public: _property void set_Item(String* header, bool); [VB] Public Default Property Item(ByVal header As String) As Boolean [JScript] returnValue=HttpCacheVaryByParamsObject.Item(header);HttpCacheVaryByParamsObject.Item(header)=returnValue;

Description

[0411] Gets or sets the name of the cache-control header that is used to select one of several different cached responses. The name of the custom header.

[0412] HttpClientCertificate class (System.Web)

[0413] ToString

Description

[0414] The HttpClientCertificate collection retrieves the certification fields (specified in the X.509 standard) from a request issued by the Web browser.

[0415] AllKeys

[0416] BinaryIssuer

[0417] ToString

Description

[0418] CertEncoding

[0419] ToString

[C#] public int CertEncoding {get;} [C++] public: _property int get_CertEncoding( ); [VB] Public ReadOnly Property CertEncoding As Integer [JScript] public function get CertEncoding( ): int;

Description

[0420] Certificate

[0421] ToString

[C#] public byte[ ] Certificate {get;} [C++] public: _property unsigned char get_Certificate( ); [VB] Public ReadOnly Property Certificate As Byte ( ) [JScript] public function get Certificate( ): Byte[ ];

Description

[0422] A string containing the binary stream of the entire certificate content in ASN.1 format.

[0423] Cookie

[0424] ToString

[C#] public string Cookie {get;} [C++] public: _property String* get_Cookie( ); [VB] Public ReadOnly Property Cookie As String [JScript] public function get Cookie( ): String;

Description

[0425] Count

[0426] Flags

[0427] ToString

Description

[0428] A set of flags that provide additional client certificate information.

[0429] IsPresent

[0430] ToString

[C#] public bool IsPresent {get;} [C++] public: _property bool get_IsPresent( ); [VB] Public ReadOnly Property IsPresent As Boolean [JScript] public function get IsPresent( ): Boolean;

Description

[0431] IsReadOnly

[0432] Issuer

[0433] ToString

Description

[0434] A string that contains a list of subfield values containing information about the certificate issuer.

[0435] IsValid

[0436] ToString

[C#] public bool IsValid {get;} [C++] public: _property bool get_IsValid( ); [VB] Public ReadOnly Property IsValid As Boolean [JScript] public function get IsValid( ): Boolean;

Description

[0437] Item

[0438] Item

[0439] Keys

[0440] KeySize

[0441] ToString

Description

[0442] PublicKey

[0443] ToString

[C#] public byte[ ] PublicKey {get;} [C++] public: _property unsigned char get_PublicKey( ); [VB] Public ReadOnly Property PublicKey As Byte ( ) [JScript] public function get PublicKey( ): Byte[ ];

Description

[0444] SecretKeySize

[0445] ToString

[C#] public int SecretKeySize {get;} [C++] public: _property int get_SecretKeySize( ); [VB] Public ReadOnly Property SecretKeySize As Integer [JScript] public function get SecretKeySize( ): int;

Description

[0446] SerialNumber

[0447] ToString

[C#] public string SerialNumber {get;} [C++] public: _property String* get_SerialNumber( ); [VB] Public ReadOnly Property SerialNumber As String [JScript] public function get SerialNumber( ): String;

Description

[0448] A string that contains the certification serial number as an ASCII representation of hexadecimal bytes separated by hyphens (-). For example, 04-67-F3-02.

[0449] ServerIssuer

[0450] ToString

[C#] public string ServerIssuer {get;} [C++] public: _property String* get_ServerIssuer( ); [VB] Public ReadOnly Property ServerIssuer As String [JScript] public function get ServerIssuer( ): String;

Description

[0451] ServerSubject

[0452] ToString

[C#] public string ServerSubject {get;} [C++] public: _property String* get_ServerSubject( ); [VB] Public ReadOnly Property ServerSubject As String [JScript] public function get ServerSubject( ): String;

Description

[0453] Subject

[0454] ToString

[C#] public string Subject {get;} [C++] public: _property String* get_Subject( ); [VB] Public ReadOnly Property Subject As String [JScript] public function get Subject( ): String;

Description

[0455] A string that contains a list of subfield values that contain information about the subject of the certificate. If this value is specified without a SubField, the ClientCertificate collection returns a comma-separated list of subfields. For example, C=US, O=Msft, and so on.

[0456] ValidFrom

[0457] ToString

[C#] public DateTime ValidFrom {get;} [C++] public: _property DateTime get_ValidFrom( ); [VB] Public ReadOnly Property ValidFrom As DateTime [JScript] public function get ValidFrom( ): DateTime;

Description

[0458] A date specifying when the certificate becomes valid. This date varies with international settings.

[0459] ValidUntil

[0460] ToString

[C#] public DateTime ValidUntil {get;} [C++] public: _property DateTime get_ValidUntil( ); [VB] Public ReadOnly Property ValidUntil As DateTime [JScript] public function get ValidUntil( ): DateTime;

Description

[0461] A date specifying when the certificate expires. The year value is displayed as a four-digit number.

[0462] Get

[C#] public override string Get(string field); [C++] public: String* Get(String* field); [VB] Overrides Public Function Get(ByVal field As String) As String [JScript] public override function Get(field: String): String;

Description

[0463] Allows access to individual items in the collection by name. The name of the item in the collection to retrieve.

[0464] HttpCompileException class (System.Web)

[0465] ToString

Description

[0466] The exception that is thrown when a compiler error occurs.

[0467] HttpCompileException

[0468] Example Syntax:

[0469] ToString

[0470] [C#] public HttpCompileException(CompilerResults results, string sourceCode); [C++] public: HttpCompileException(CompilerResults* results, String* sourceCode); [VB] Public Sub New(ByVal results As CompilerResults, ByVal sourceCode As String) [JScript] public function HttpCompileException(results: CompilerResults, sourceCode: String);

Description

[0471] Initializes a new instance of the System.Web.HttpCompileException class. A System.CodeDom.Compiler.CompilerResults containing compiler output and error information. The name of the file being compiled when the error occurs.

[0472] ErrorCode

[0473] HelpLink

[0474] HResult

[0475] InnerException

[0476] Message

[0477] Results

[0478] ToString

Description

[0479] Gets compiler output and error information for the exception.

[0480] Source

[0481] SourceCode

[0482] ToString

Description

[0483] Gets the name of the source file being compiled when the error occurs.

[0484] StackTrace

[0485] TargetSite

[0486] HttpContext class (System.Web)

[0487] ToString

Description

[0488] Encapsulates all HTTP-specific information about an individual HTTP request.

[0489] Classes that inherit the System.Web.IHttpModule and System.Web.IHttpHandler interfaces are provided a reference to an HttpContext object for the current HTTP request. The object provides access to the intrinsic System.Web.HttpContext.Request, System.Web.HttpContext.Response, and System.Web.HttpContext.Server objects for the request.

[0490] HttpContext

[0491] Example Syntax:

[0492] ToString

[C#] public HttpContext(HttpWorkerRequest wr); [C++] public: HttpContext(HttpWorkerRequest* wr); [VB] Public Sub New(ByVal wr As HttpWorkerRequest) [JScript] public function HttpContext(wr: HttpWorkerRequest);

Description

[0493] Initializes a new instance of the System.Web.HttpContext class. The System.Web.HttpWorkerRequest object for the current HTTP request.

[0494] HttpContext

[0495] Example Syntax:

[0496] ToString

[0497] [C#] public HttpContext(HttpRequest request, HttpResponse response); [C++] public: HttpContext(HttpRequest* request, HttpResponse* response); [VB] Public Sub New(ByVal request As HttpRequest, ByVal response As HttpResponse) [JScript] public function HttpContext(request: HttpRequest, response: HttpResponse); Initializes a new instance of the System.Web.HttpContext class.

Description

[0498] Initializes a new instance of the System.Web.HttpContext class. The System.Web.HttpRequest object for the current HTTP request. The System.Web.HttpResponse object for the current HTTP request.

[0499] AllErrors

[0500] ToString

[C#] public Exception[ ] AllErrors {get;} [C++] public: _property Exception* get_AllErrors( ); [VB] Public ReadOnly Property AllErrors As Exception ( ) [JScript] public function get AllErrors( ): Exception[ ];

Description

[0501] Gets an array of errors accumulated while processing an HTTP request.

[0502] Application

[0503] ToString

[0504] [C#] public HttpApplicationState Application {get;} [C++] public: _property HttpApplicationState* get_Application( ); [VB] Public ReadOnly Property Application As HttpApplicationState [JScript] public function get Application( ): HttpApplicationState;

Description

[0505] Gets the System.Web.HttpApplicationState object for the current HTTP request.

[0506] ApplicationInstance

[0507] ToString

[0508] [C#] public HttpApplication ApplicationInstance {get; set;} [C++] public: _property HttpApplication* get_ApplicationInstance( );public: _property void set_ApplicationInstance(HttpApplication*); [VB] Public Property ApplicationInstance As HttpApplication [JScript] public function get ApplicationInstance( ): HttpApplication;public function set ApplicationInstance(HttpApplication);

Description

[0509] Gets or sets the System.Web.HttpApplicationState object for the current HTTP request.

[0510] Cache

[0511] ToString

[C#] public Cache Cache {get;} [C++] public: _property Cache* get_Cache( ); [VB] Public ReadOnly Property Cache As Cache [JScript] public function get Cache( ): Cache;

Description

[0512] Gets the System.Web.Caching.Cache object for the current HTTP request.

[0513] Current

[0514] ToString

[C#] public static HttpContext Current {get;} [C++] public: _property static HttpContext* get_Current( ); [VB] Public Shared ReadOnly Property Current As HttpContext [JScript] public static function get Current( ): HttpContext;

Description

[0515] Gets the System.Web.HttpContext object for the current HTTP request.

[0516] Error

[0517] ToString

[C#] public Exception Error {get;} [C++] public: _property Exception* get_Error( ); [VB] Public ReadOnly Property Error As Exception [JScript] public function get Error( ): Exception;

Description

[0518] Gets the first error (if any) accumulated during HTTP request processing.

[0519] Handler

[0520] ToString

[0521] [C#] public IHttpHandler Handler {get; set;} [C++] public: _property IHttpHandler* get_Handler( );public: _property void set_Handler(IHttpHandler*); [VB] Public Property Handler As IHttpHandler [JScript] public function get Handler( ): IHttpHandler;public function set Handler(IHttpHandler);

Description

[0522] Gets or sets the System.Web.IHttpHandler object for the current HTTP request.

[0523] IsCustomErrorEnabled

[0524] ToString

[C#] public bool IsCustomErrorEnabled {get;} [C++] public: _property bool get_IsCustomErrorEnabled( ); [VB] Public ReadOnly Property IsCustomErrorEnabled As Boolean [JScript] public function get IsCustomErrorEnabled( ): Boolean;

Description

[0525] Gets a value indicating whether custom errors are enabled for the current HTTP request.

[0526] IsDebuggingEnabled

[0527] ToString

[C#] public bool IsDebuggingEnabled {get;} [C++] public: _property bool get_IsDebuggingEnabled( ); [VB] Public ReadOnly Property IsDebuggingEnabled As Boolean [JScript] public function get IsDebuggingEnabled( ): Boolean;

Description

[0528] Gets a value indicating whether the current HTTP request is in debug mode.

[0529] Items

[0530] ToString

[C#] public IDictionary Items {get;} [C++] public: _property IDictionary* get_Items( ); [VB] Public ReadOnly Property Items As IDictionary [JScript] public function get Items( ): IDictionary;

Description

[0531] Gets a key-value collection that can be used to organize and share data between an System.Web.IHttpModule and an System.Web.IHttpHandler during an HTTP request.

[0532] Request

[0533] ToString

[C#] public HttpRequest Request {get;} [C++] public: _property HttpRequest* get_Request( ); [VB] Public ReadOnly Property Request As HttpRequest [JScript] public function get Request( ): HttpRequest;

Description

[0534] Gets the System.Web.HttpRequest object for the current HTTP request.

[0535] Response

[0536] ToString

[C#] public HttpResponse Response {get;} [C++] public: _property HttpResponse* get_Response( ); [VB] Public ReadOnly Property Response As HttpResponse [JScript] public function get Response( ): HttpResponse;

Description

[0537] Gets the System.Web.HttpResponse object for the current HTTP response.

[0538] Server

[0539] ToString

[C#] public HttpServerUtility Server {get;} [C++] public: _property HttpServerUtility* get_Server( ); [VB] Public ReadOnly Property Server As HttpServerUtility [JScript] public function get Server( ): HttpServerUtility;

Description

[0540] Gets the System.Web.HttpServerUtility object that provides methods used in processing Web requests.

[0541] Session

[0542] ToString

[C#] public HttpSessionState Session {get;} [C++] public: _property HttpSessionState* get_Session( ); [VB] Public ReadOnly Property Session As HttpSessionState [JScript] public function get Session( ): HttpSessionState;

Description

[0543] Gets the System.Web.SessionState instance for the current HTTP request.

[0544] SkipAuthorization

[0545] ToString

[0546] [C#] public bool SkipAuthorization {get; set;} [C++] public: _property bool get_SkipAuthorization( );public: _property void set SkipAuthorization(bool); [VB] Public Property SkipAuthorization As Boolean [JScript] public function get SkipAuthorization( ): Boolean;public function set SkipAuthorization(Boolean);

Description

[0547] Gets or sets a value that specifies whether the URLAuthorization module will skip the authorization check for the current request.

[0548] SkipAuthorization is for advanced use by authentication modules that need to redirect to an anonymous-allowed page. The Forms authentication module and Passport authentication module both set this property when redirecting to a configured login page. Setting this requires the ControlPrincipal flag to be set in System.Security.Permissions.SecurityPermission.Flags.

[0549] Timestamp

[0550] ToString

[C#] public DateTime Timestamp {get;} [C++] public: _property DateTime get_Timestamp( ); [VB] Public ReadOnly Property Timestamp As DateTime [JScript] public function get Timestamp( ): DateTime;

Description

[0551] Gets the initial timestamp of the current HTTP request.

[0552] Trace

[0553] ToString

[C#] public TraceContext Trace {get;} [C++] public: _property TraceContext* get_Trace( ); [VB] Public ReadOnly Property Trace As TraceContext [JScript] public function get Trace( ): TraceContext;

Description

[0554] Gets the System.Web.TraceContext object for the current HTTP response.

[0555] User

[0556] ToString

[0557] [C#] public IPrincipal User {get; set;} [C++] public: _property Iprincipal* get_User( );public: _property void set_User(IPrincipal*); [VB] Public Property User As IPrincipal [JScript] public function get User( ): IPrincipal;public function set User(IPrincipal);

Description

[0558] Gets or sets security information for the current HTTP request.

[0559] Setting this property requires the ControlPrincipal flag to be set in System.Security.Permissions.SecurityPermission.Flags.

[0560] AddError

[C#] public void AddError(Exception errorInfo); [C++] public: void AddError(Exception* errorInfo); [VB] Public Sub AddError(ByVal errorInfo As Exception) [JScript] public function AddError(errorInfo: Exception);

Description

[0561] Adds an exception to the exception collection for the current HTTP request. The System.Exception object to add to the exception collection.

[0562] ClearError

[C#] public void ClearError( ); [C++] public: void ClearError( ); [VB] Public Sub ClearError( ) [JScript] public function ClearError( );

Description

[0563] Clears all errors for the current HTTP request.

[0564] GetAppConfig

[0565] [C#] public static object GetAppConfig(string name); [C++] public: static Object* GetAppConfig(String* name); [VB] Public Shared Function GetAppConfig(ByVal name As String) As Object [JScript] public static function GetAppConfig(name: String): Object;

Description

[0566] Returns requested configuration information for the current application The application configuration tag that information is requested for.

[0567] GetConfig

[0568] [C#] public object GetConfig(string name); [C++] public: Object* GetConfig(String* name); [VB] Public Function GetConfig(ByVal name As String) As Object [JScript] public function GetConfig(name: String): Object; Returns requested configuration information for the current HTTP request.

Description

[0569] Returns requested configuration information for the current HTTP request. The configuration tag that information is requested for.

[0570] RewritePath

[C#] public void RewritePath(string path); [C++] public: Void RewritePath(String* path); [VB] Public Sub RewritePath(ByVal path As String) [JScript] public function RewritePath(path: String);

Description

[0571] Assigns an internal rewrite path. The internal rewrite path.

[0572] IServiceProvider.GetService

[0573] [C#] object IServiceProvider.GetService(Type service); [C++] Object* IServiceProvider::GetService(Type* service); [VB] Function GetService(ByVal service As Type) As Object Implements IServiceProvider.GetService [JScript] function IServiceProvider.GetService(service: Type): Object;

[0574] HttpCookie class (System.Web)

[0575] ToString

Description

[0576] Provides a type-safe way to create and manipulate individual HTTP cookies.

[0577] The System.Web.HttpCookie class gets and sets properties of individual 11 cookies. The System.Web.HttpCookieCollection class provides methods to store, retrieve, and manage all the cookies for an entire Web application. ASP.NET code uses the intrinsic System.Web.HttpResponse.Cookies object to create cookies and add them to the cookie collection. When delivering a Web page to a client, the server sends the entire cookie collection with the Set-Cookie header.

[0578] HttpCookie

[0579] Example Syntax:

[0580] ToString

[C#] public HttpCookie(string name); [C++] public: HttpCookle(String* name); [VB] Public Sub New(ByVal name As String) [JScript] public function HttpCookie(name: String); Initializes a new instance of the System.Web.HttpCookie class.

Description

[0581] Creates and names a new cookie. The name of the new cookie.

[0582] HttpCookie

[0583] Example Syntax:

[0584] ToString

[C#] public HttpCookie(string name, string value); [C++] public: HttpCookle(String* name, String* value); [VB] Public Sub New(ByVal name As String, ByVal value As String) [JScript] public function HttpCookie(name: String, value: String);

Description

[0585] Creates, names, and assigns a value to a new cookie. The name of the new cookie. The value of the new cookie.

[0586] Domain

[0587] ToString

[C#] public string Domain {get; set;} [C++] public: _property String* get_Domain( );public: _property void set_Domain(String*); [VB] Public Property Domain As String [JScript] public function get Domain( ): String;public function set Domain(String);

Description

[0588] Gets or sets the domain to associate the cookie with.

[0589] Setting the Domain attribute limits transmission of the cookie to clients requesting a resource from that domain.

[0590] Expires

[0591] ToString

[0592] [C#] public DateTime Expires {get; set;} [C++] public: _property DateTime get_Expires( );public: _property void set_Expires(DateTime); [VB] Public Property Expires As DateTime [JScript] public function get Expires( ): DateTime;public function set Expires(DateTime);

Description

[0593] Gets or sets the expiration date and time for the cookie.

[0594] HasKeys

[0595] ToString

[C#] public bool HasKeys {get;} [C++] public: _property bool get_HasKeys( ); [VB] Public ReadOnly Property HasKeys As Boolean [JScript] public function get HasKeys( ): Boolean;

Description

[0596] Gets a value indicating whether a cookie has subkeys.

[0597] Item

[0598] ToString

[0599] [C#] public string this[string key] {get; set;} [C++] public: _property String* get_Item(String* key);public: _property void set_Item(String* key, String*); [VB] Public Default Property Item(ByVal key As String) As String [JScript] returnValue =HttpCookieObject.Item(key);HttpCookieObject.Item(key)=returnValue;

Description

[0600] Shortcut for HttpCookie.Values[key]. This property is provided for compatibility with previous versions of ASP. Key (index) of cookie value.

[0601] Name

[0602] ToString

[C#] public string Name {get; set;} [C++] public: _property String* get_Name( );public: _property void set_Name(String*); [VB] Public Property Name As String [JScript] public function get Name( ): String;public function set Name(String);

Description

[0603] Gets or sets the name of a cookie.

[0604] Path

[0605] ToString

[C#] public string Path {get; set;} [C++] public: _property String* get_Path( );public: _property void set_Path(String*); [VB] Public Property Path As String [JScript] public function get Path( ): String;public function set Path(String);

Description

[0606] Gets or sets the virtual path to transmit with the current cookie.

[0607] The Path property extends the Domain property to completely describe the specific URL that the cookie applies to. For example, in the URL http:/www.microsoft.com/asp, the domain is www.microsoft.com and the path is /asp.

[0608] Secure

[0609] ToString

[C#] public bool Secure {get; set;} [C++] public: _property bool get_Secure( );public: _property void set_Secure(bool); [VB] Public Property Secure As Boolean [JScript] public function get Secure( ): Boolean;public function set Secure(Boolean);

Description

[0610] Gets or sets a value indicating whether to transmit the cookie securely (that is, over HTTPS only).

[0611] Value

[0612] ToString

[C#] public string Value {get; set;} [C++] public: _property String* get_Value( );public: _property void set_Value(String*); [VB] Public Property Value As String [JScript] public function get Value( ): String;public function set Value(String);

Description

[0613] Gets or sets an individual cookie value.

[0614] Values

[0615] ToString

[C#] public NameValueCollection Values {get;} [C++] public: _property NameValueCollection* get_Values( ); [VB] Public ReadOnly Property Values As NameValueCollection [JScript] public function get Values( ): NameValueCollection;

Description

[0616] Gets a collection of key-and-value value pairs that are contained within a single cookie object.

[0617] HttpCookieCollection class (System.Web)

[0618] ToString

Description

[0619] Provides a type-safe way to manipulate HTTP cookies.

[0620] HttpCookieCollection

[0621] Example Syntax:

[0622] ToString

[C#] public HttpCookieCollection( ); [C++ public: HttpCookieCollection( ); [VB] Public Sub New( ) [JScript] public function HttpCookieCollection( );

Description

[0623] Initializes a new instance of the System.Web.HttpCookieCollection class.

[0624] ASP.NET includes two intrinsic cookie collections. The collection accessible through System.Web.HttpRequest.Cookies contains cookies transmitted by the client to the server in the Cookie header. The collection accessible through System.Web.HttpResponse.Cookies contains cookies generated on the server and transmitted to the client in the Set-Cookie header.

[0625] AllKeys

[0626] ToString

[C#] public string[ ] AllKeys {get;} [C++] public: _property String* get_AllKeys( ); [VB] Public ReadOnly Property AllKeys As String ( ) [JScript] public function get AllKeys( ): String[ ];

Description

[0627] Gets a string array containing all the keys (cookie names) in the cookie collection.

[0628] Count

[0629] IsReadOnly

[0630] Item

[0631] ToString

Description

[0632] Gets the cookie with the specified numerical index from the cookie collection. The index of the cookie to retrieve from the collection.

[0633] Item

[0634] ToString

[0635] [C#] public HttpCookie this[string name] {get;} [C++] public: _property HttpCookie* get_Item(String* name); [VB] Public Default ReadOnly Property Item(ByVal name As String) As HttpCookie [JScript] returnValue=HttpCookieCollectionObject.Item(name); Gets the cookie with the specified name from the cookie collection. This property is overloaded to allow retrieval of cookies by either name or numerical index.

Description

[0636] Gets the cookie with the specified name from the cookie collection. Name of cookie to retrieve.

[0637] Keys

[0638] Add

[C#] public void Add(HttpCookie cookie); [C++] public: Void Add(HttpCookle* cookie); [VB] Public Sub Add(ByVal cookie As HttpCookie) [JScript] public function Add(cookie: HttpCookie);

Description

[0639] Adds the specified cookie to the cookie collection.

[0640] Any number of cookie collections can exist within an application, but only the collection referenced by the intrinsic System.Web.HttpResponse.Cookies object is sent to the client. The System.Web.HttpCookie to add to the collection.

[0641] Clear

[C#] public void Clear( ); [C++] public: void Clear( ); [VB] Public Sub Clear( ) [JScript] public function Clear( );

Description

[0642] Clears all cookies from the cookie collection.

[0643] CopyTo

[C#] public void CopyTo(Array dest, int index); [C++] public: void CopyTo(Array* dest, int index); [VB] Public Sub CopyTo(ByVal dest As Array, ByVal index As Integer) [JScript] public function CopyTo(dest: Array, index: int);

Description

[0644] Copies members of the cookie collection to an System.Array beginning at the specified index of the array. The destination System.Array. The index of the destination array where copying starts.

[0645] Get

[C#] public HttpCookie Get(int index); [C++] public: HttpCookie* Get(int index); [VB] Public Function Get(ByVal index As Integer) As HttpCookie [JScript] public function Get(index: int): HttpCookie;

Description

[0646] Returns the System.Web.HttpCookie item with the specified index from the cookie collection. The index of the cookie to return from the collection.

[0647] Get

[0648] [C#] public HttpCookie Get(string name); [C++] public: HttpCookie* Get(String* name); [VB] Public Function Get(ByVal name As String) As HttpCookie [JScript] public function Get(name: String): HttpCookie; Returns an individual System.Web.HttpCookie object from the cookie collection. This property is overloaded to allow retrieval of cookies by either name or numerical index.

Description

[0649] Returns the System.Web.HttpCookie item with the specified name from the cookie collection.

[0650] If the named cookie does not exist, this method creates a new cookie with that name. The name of the cookie to retrieve from the collection.

[0651] GetKey

[C#] public string GetKey(int index); [C++] public: String* GetKey(int index); [VB] Public Function GetKey(ByVal index As Integer) As String [JScript] public function GetKey(index: int): String;

Description

[0652] Returns the key (name) of the cookie at the specified numerical index. The index of the key to retrieve from the collection.

[0653] Remove

[C#] public void Remove(string name); [C++] public: void Remove(String* name); [VB] Public Sub Remove(ByVal name As String) [JScript] public function Remove(name: String);

Description

[0654] Removes the cookie with the specified name from the collection. The name of the cookie to remove from the collection.

[0655] Set

[C#] public void Set(HttpCookie cookie); [C++] public: void Set(HttpCookle* cookie); [VB] Public Sub Set(ByVal cookie As HttpCookie) [JScript] public function Set(cookie: HttpCookie);

Description

[0656] Updates the value of an existing cookie in a cookie collection. The System.Web.HttpCookie object to update.

[0657] HttpException class (System.Web)

[0658] ToString

Description

[0659] Provides a means of generating HTTP exceptions.

[0660] HttpException

[0661] Example Syntax:

[0662] ToString

[C#] public HttpException( ); [C++] public: HttpException( ); [VB] Public Sub New( ) [JScript] public function HttpException( ); Constructs a new System.Exception object.

Description

[0663] Constructs an empty Exception object.

[0664] When handling exceptions, it is sometimes useful to capture a series of related exceptions with the outer exceptions being thrown in response to an inner exceptions.

[0665] HttpException

[0666] Example Syntax:

[0667] ToString

[C#] public HttpException(string message); [C++] public: HttpException(String* message); [VB] Public Sub New(ByVal message As String) [JScript] public function HttpException(message: String);

Description

[0668] Constructs an System.Exception using a supplied error message. The message displayed to the client when the exception is thrown.

[0669] HttpException

[0670] Example Syntax:

[0671] ToString

[0672] [C#] public HttpException(int httpCode, string message); [C++] public: HttpException(int httpCode, String* message); [VB] Public Sub New(ByVal httpCode As Integer, ByVal message As String) [JScript] public function HttpException(httpCode: int, message: String);

Description

[0673] Constructs an System.Exception using an HTTP error code and an error message. The HTTP error code displayed on the client. The message displayed to the client when the exception is thrown.

[0674] HttpException

[0675] Example Syntax:

[0676] ToString

[0677] [C#] public HttpException(string message, Exception innerException); [C++] public: HttpException(String* message, Exception* innerException); [VB] Public Sub New(ByVal message As String, ByVal innerException As Exception) [JScript] public function HttpException(message: String, innerException: Exception);

Description

[0678] Constructs an System.Exception using an error message and the System.Exception.InnerException property.

[0679] When handling exceptions, it is sometimes useful to capture a series of related exceptions with the outer exceptions being thrown in response to an inner exception. The message displayed to the client when the exception is thrown. The System.Exception.InnerException, if any, that threw the current exception.

[0680] HttpException

[0681] Example Syntax:

[0682] ToString

[C#] public HttpException(string message, int hr); [C++] public: HttpException(String* message, int hr); [VB] Public Sub New(ByVal message As String, ByVal hr As Integer) [JScript] public function HttpException(message: String, hr: int);

Description

[0683] Constructs an System.Exception using error message and an exception code. The error message displayed to the client when the exception is thrown. The exception code that defines the error.

[0684] HttpException

[0685] Example Syntax:

[0686] ToString

[0687] [C#] public HttpException(int httpCode, string message, Exception innerException); [C++] public: HttpException(int httpCode, String* message, Exception* innerException); [VB] Public Sub New(ByVal httpCode As Integer, ByVal message As String, ByVal innerException As Exception) [JScript] public function HttpException(httpCode: int, message: String, innerException Exception);

Description

[0688] Constructs an System.Exception using an HTTP error code, an error message, and the System.Exception.InnerException property.

[0689] When handling exceptions, it is sometimes useful to capture a series of related exceptions with the outer exceptions being thrown in response to an inner exceptions. The HTTP error code displayed to the client. The message displayed to the client. The InnerException, if any, that threw the current exception.

[0690] HttpException

[0691] Example Syntax:

[0692] ToString

[0693] [C#] public HttpException(int httpCode, string message, int hr); [C++] public: HttpException(int httpCode, String* message, int hr); [VB] Public Sub New(ByVal httpCode As Integer, ByVal message As String, ByVal hr As Integer) [JScript] public function HttpException(httpCode: int, message: String, hr: int);

Description

[0694] Constructs an System.Exception using HTTP error code, an error message, and an exception code. The HTTP error code displayed on the client. The error message displayed to the client. The error code that defines the error.

[0695] ErrorCode

[0696] HelpLink

[0697] HResult

[0698] InnerException

[0699] Message

[0700] Source

[0701] StackTrace

[0702] TargetSite

[0703] CreateFromLastError

[0704] [C#] public static HttpException CreateFromLastError(string message); [C++] public: static HttpException* CreateFromLastError(String* message); [VB] Public Shared Function CreateFromLastError(ByVal message As String) As HttpException [JScript] public static function CreateFromLastError(message: String): HttpException;

Description

[0705] Creates a new System.Exception based on the previous Exception.

Return Value: An Exception with the same error identification code as the previous Exception but with a new message. The message to be displayed to the client when the exception is thrown.

[0706] GetHtmlErrorMessage

[C#] public string GetHtmlErrorMessage( ); [C++] public: String* GetHtmlErrorMessage( ); [VB] Public Function GetHtmlErrorMessage( ) As String [JScript] public function GetHtmlErrorMessage( ) String;

Description

[0707] Returns the HTTP error message to send back to the client. Return Value: The HTTP error message.

[0708] GetHttpCode

[C#] public int GetHttpCode( ); [C++] public: int GetHttpCode( ); [VB] Public Function GetHttpCode( ) As Integer [JScript] public function GetHttpCode( ): int;

Description

[0709] Returns the HTTP error code to send back to the client. If there is a nonzero HTTP code, it is returned. Otherwise, the System.Exception.InnerException code is returned. If neither an InnerException code nor a nonzero HTTP code is available, the HTTP error code 500 is returned.

Return Value: The HTTP code representing the exception.

[0710] HttpFileCollection class (System.Web)

[0711] ToString

Description

[0712] Provides access to and organizes files uploaded by a client.

[0713] Clients encode files and transmit them in the content body using multipart MIME format with an HTTP Content-Type header of multipart/form-data. ASP.NET extracts the encoded file(s) from the content body into individual members of an System.Web.HttpFileCollection. Methods and properties of the System.Web.HttpPostedFile class provide access to the contents and properties of each file.

[0714] AllKeys

[0715] ToString

[C#] public string[ ] AllKeys {get;} [C++] public: _property String* get_AllKeys( ); [VB] Public ReadOnly Property AllKeys As String ( ) [JScript] public function get AllKeys( ): String[ ];

Description

[0716] Gets a string array containing the keys (names) of all members in the file collection.

[0717] Count

[0718] IsReadOnly

[0719] Item

[0720] ToString

Description

[0721] Gets the object with the specified numerical index from the System.Web.HttpFileCollection. The index of the item to get from the file collection.

[0722] Item

[0723] ToString

[0724] [C#] public HttpPostedFile this[string name] {get;} [C++] public: _property HttpPostedFile* get_Item(String* name); [VB] Public Default ReadOnly Property Item(ByVal name As String) As HttpPostedFile [JScript] returnValue=HttpFileCollectionObject.Item(name); Gets an individual System.Web.HttpPostedFile object from the file collection. This property is overloaded to allow retrieval of objects by either name or numerical index.

Description

[0725] Gets the object with the specified name from the file collection. Name of item to be returned.

[0726] Keys

[0727] CopyTo

[C#] public void CopyTo(Array dest, int index); [C++] public: void CopyTo(Array* dest, int index); [VB] Public Sub CopyTo(ByVal dest As Array, ByVal index As Integer) [JScript] public function CopyTo(dest: Array, index: int);

Description

[0728] Copies members of the file collection to an System.Array beginning at the specified index of the array. The destination System.Array. The index of the destination array where copying starts.

[0729] Get

[C#] public HttpPostedFile Get(int index); [C++] public: HttpPostedFile* Get(int index); [VB] Public Function Get(ByVal index As Integer) As HttpPostedFile [JScript] public function Get(index: int): HttpPostedFile;

Description

[0730] Returns the System.Web.HttpPostedFile object with the specified numerical index from the file collection. The index of the object to be returned from the file collection.

[0731] Get

[0732] [C#] public HttpPostedFile Get(string name); [C++] public: HttpPostedFile* Get(String* name); [VB] Public Function Get(ByVal name As String) As HttpPostedFile [JScript] public function Get(name: String): HttpPostedFile; Returns an individual System.Web.HttpPostedFile object from a file collection. This property is overloaded to allow retrieval of objects by either name or numerical index.

Description

[0733] Returns the System.Web.HttpPostedFile object with the specified name from the file collection. The name of the object to be returned from a file collection.

[0734] GetKey

[C#] public string GetKey(int index); [C++] public: String* GetKey(int index); [VB] Public Function GetKey(ByVal index As Integer) As String [JScript] public function GetKey(index: int): String;

Description

[0735] Returns the name of the System.Web.HttpFileCollection member with the specified numerical index. The index of the object name to be returned.

[0736] HttpModuleCollection class (System.Web)

[0737] ToString

Description

[0738] Provides a means of indexing and retrieving a collection of System.Web.IHttpModule objects.

[0739] AllKeys

[0740] ToString

[C#] public string[ ] AllKeys {get;} [C++] public: _property String* get_AllKeys( ); [VB] Public ReadOnly Property AllKeys As String ( ) [JScript] public function get AllKeys( ): String[ ];

Description

[0741] Gets a string array containing all the keys (module names) in the System.Web.HttpModuleCollection.

[0742] Count

[0743] IsReadOnly

[0744] Item

[0745] ToString

Description

[0746] Gets the System.Web.IHttpModule object with the specified numerical index from the System.Web.HttpModuleCollection. The index of the System.Web.IHttpModule object to retrieve from the collection.

[0747] Item

[0748] ToString

[0749] [C#] public IHttpModule this[string name] {get;} [C++] public: _property IHttpModule* get_Item(String* name); [VB] Public Default ReadOnly Property Item(ByVal name As String) As IHttpModule [JScript] returnValue=HttpModuleCollectionObject.Item(name); Gets the System.Web.IHttpModule object with the specified name from the System.Web.HttpModuleCollection. This property is overloaded to allow retrieval of modules by either name or numerical index.

Description

[0750] Gets the System.Web.IHttpModule object with the specified name from the System.Web.HttpModuleCollection. Key of the item to be retrieved.

[0751] Keys

[0752] CopyTo

[C#] public void CopyTo(Array dest, int index); [C++] public: void CopyTo(Array * dest, int index); [VB] Public Sub CopyTo(ByVal dest As Array, ByVal index As Integer) [JScript] public function CopyTo(dest: Array, index: int);

Description

[0753] Copies members of the module collection to an System.Array beginning at the specified index of the array. The destination Array. The index of the destination Array where copying starts.

[0754] Get

[C#] public IHttpModule Get(int index); [C++] public: IHttpModule* Get(int index); [VB] Public Function Get(ByVal index As Integer) As IHttpModule [JScript] public function Get(index: int): IHttpModule;

Description

[0755] Returns the System.Web.IHttpModule object with the specified index from the System.Web.HttpModuleCollection. Index of the System.Web.IHttpModule object to return from the collection.

[0756] Get

[0757] [C#] public IHttpModule Get(string name); [C++] public: IHttpModule* Get(String* name); [VB] Public Function Get(ByVal name As String) As IHttpModule [JScript] public function Get(name: String): IHttpModule; Returns an individual System.Web.IHttpModule object from the System.Web.HttpModuleCollection. This property is overloaded to allow retrieval of modules by either name or numerical index.

Description

[0758] Returns the System.Web.IHttpModule object with the specified name from the System.Web.HttpModuleCollection. Key of the item to be retrieved.

[0759] GetKey

[C#] public string GetKey(int index); [C++] public: String* GetKey(int index); [VB] Public Function GetKey(ByVal index As Integer) As String [JScript] public function GetKey(index: int): String;

Description

[0760] Returns the key (name) of the System.Web.IHttpModule object at the specified numerical index. Index of the key to retrieve from the collection.

[0761] HttpParseException class (System.Web)

[0762] ToString

Description

[0763] The exception that is thrown when a parse error occurs.

[0764] HttpParseException

[0765] Example Syntax:

[0766] ToString

[0767] [C#] public HttpParseException(string message, Exception innerException, string fileName, int line); [C++] public: HttpParseException(String* message, Exception* innerException, String* filename, int line); [VB] Public Sub New(ByVal message As String, ByVal innerException As Exception, ByVal fileName As String, ByVal line As Integer) [JScript] public function HttpParseException(message: String, innerException: Exception, fileName: String, line: int);

Description

[0768] Initializes a new instance of the System.Web.HttpParseException class. 11 The message displayed to the client when the exception is thrown. The System.Exception, if any, that threw the current exception. The name of the file being parsed when the error occurs. The number of the line being parsed when the error occurs.

[0769] ErrorCode

[0770] FileName

[0771] ToString

Description

[0772] Gets the name of the file being parsed when the error occurs.

[0773] HelpLink

[0774] HResult

[0775] InnerException

[0776] Line

[0777] ToString

Description

[0778] Gets the number of the line being parsed when the error occurs.

[0779] Message

[0780] Source

[0781] StackTrace

[0782] TargetSite

[0783] HttpPostedFile class (System.Web)

[0784] ToString

Description

[0785] Provides a way to access individual files that have been uploaded by a client.

[0786] The System.Web.HttpFileCollection class provides access to all the files uploaded from a client as a file collection.

[0787] ContentLength

[0788] ToString

[C#] public int ContentLength {get;} [C++] public: _property int get_ContentLength( ); [VB] Public ReadOnly Property ContentLength As Integer [JScript] public function get ContentLength( ): int;

Description

[0789] Gets the size in bytes of an uploaded file.

[0790] ContentType

[0791] ToString

[C#] public string ContentType {get;} [C++] public: _property String* get_ContentType( ); [VB] Public ReadOnly Property ContentType As String [JScript] public function get ContentType( ): String;

Description

[0792] Gets the MIME content type of a file sent by a client.

[0793] FileName

[0794] ToString

[C#] public string FileName {get;} [C++] public: _property String* get_FileName( ); [VB] Public ReadOnly Property FileName As String [JScript] public function get FileName( ): String;

Description

[0795] Gets the fully-qualified name of the file on the client's machine (for example “C:\MyFiles\Test.txt”).

[0796] InputStream

[0797] ToString

[C#] public Stream InputStream {get;} [C++] public: _property Stream* get_InputStream( ); [VB] Public ReadOnly Property InputStream As Stream [JScript] public function get InputStream( ): Stream;

Description

[0798] Gets a System.IO.Stream object which points to an uploaded file to prepare for reading the contents of the file.

[0799] SaveAs

[C#] public void SaveAs(string filename); [C++] public: Void SaveAs(String* filename); [VB] Public Sub SaveAs(ByVal filename As String) [JScript] public function SaveAs(filename: String);

Description

[0800] Saves an uploaded MIME message body to a file on the server. The name of the file.

[0801] HttpRequest class (System.Web)

[0802] ToString

Description

[0803] Enables ASP.NET to read the HTTP values sent by a client during a Web request.

[0804] HttpRequest

[0805] Example Syntax:

[0806] ToString

[0807] [C#] public HttpRequest(string filename, string url, string queryString); [C++] public: HttpRequest(String* filename, String* url, String* queryString); [VB] Public Sub New(ByVal filename As String, ByVal url As String, ByVal queryString As String) [JScript] public function HttpRequest(filename: String, url: String, queryString: String);

Description

[0808] Initializes an System.Web.HttpRequest object. The name of the file associated with the request. Information regarding the URL of the current request. The entire query string sent with the request (everything after the ‘?’).

[0809] AcceptTypes

[0810] ToString

[C#] public string[ ] AcceptTypes {get;} [C++] public: _property String* get_AcceptTypes( ); [VB] Public ReadOnly Property AcceptTypes As String ( ) [JScript] public function get AcceptTypes( ): String[ ];

Description

[0811] Gets a string array of client-supported MIME accept types.

[0812] ApplicationPath

[0813] ToString

[C#] public string ApplicationPath {get;} [C++] public: _property String* get_ApplicationPath( ); [VB] Public ReadOnly Property ApplicationPath As String [JScript] public function get ApplicationPath( ): String;

Description

[0814] Gets the ASP.NET application's virtual application root path on the server.

[0815] Browser

[0816] ToString

[0817] [C#] public HttpBrowserCapabilities Browser {get; set;} [C++] public: _property HttpBrowserCapabilities* get_Browser( );public: _property void set_Browser(HttpBrowserCapabilities*); [VB] Public Property Browser As HttpBrowserCapabilities [JScript] public function get Browser( ): HttpBrowserCapabilities;public function set Browser(HttpBrowserCapabilities);

Description

[0818] Gets information about the requesting client's browser capabilities.

[0819] ClientCertificate

[0820] ToString

[0821] [C#] public HttpClientCertificate ClientCertificate {get;} [C++] public: _property HttpClientCertificate* get_ClientCertificate( ); [VB] Public ReadOnly Property ClientCertificate As HttpClientCertificate [JScript] public function get ClientCertificate( ): HttpClientCertificate;

Description

[0822] Gets the current request's client security certificate.

[0823] ContentEncoding

[0824] ToString

[C#] public Encoding ContentEncoding {get;} [C++] public: _property Encoding* get_ContentEncoding( ); [VB] Public ReadOnly Property ContentEncoding As Encoding [JScript] public function get ContentEncoding( ): Encoding;

Description

[0825] Gets the character set of the entity-body.

[0826] Default ContentEncoding can be specified in an ASP.NET configuration file. If ContentEncoding is specified by the client, the default configuration settings are overridden.

[0827] ContentLength

[0828] ToString

[C#] public int ContentLength {get;} [C++] public: _property int get_ContentLength( ); [VB] Public ReadOnly Property ContentLength As Integer [JScript] public function get ContentLength( ): int;

Description

[0829] Specifies the length, in bytes, of content sent by the client.

[0830] ContentType

[0831] ToString

[C#] public string ContentType {get;} [C++] public: _property String* get_ContentType( ); [VB] Public ReadOnly Property ContentType As String [JScript] public function get ContentType( ): String;

Description

[0832] Gets the MIME content type of the incoming request.

[0833] Cookies

[0834] ToString

[C#] public HttpCookieCollection Cookies {get;} [C++] public: _property HttpCookieCollection* get_Cookies( ); [VB] Public ReadOnly Property Cookies As HttpCookieCollection [JScript] public function get Cookies( ): HttpCookieCollection;

Description

[0835] Gets a collection of cookies sent by the client.

[0836] ASP.NET includes two intrinsic cookie collections. The collection accessed through System.Web.HttpRequest.Cookies contains cookies transmitted by the client to the server in the Cookie header. The collection accessed through System.Web.HttpResponse.Cookies contains cookies generated on the server and transmitted to the client in the Set-Cookie header.

[0837] CurrentExecutionFilePath

[0838] ToString

[C#] public string CurrentExecutionFilePath {get;} [C++] public: _property String* get_CurrentExecutionFilePath( ); [VB] Public ReadOnly Property CurrentExecutionFilePath As String [JScript] public function get CurrentExecutionFilePath( ): String;

[0839] FilePath

[0840] ToString

[C#] public string FilePath {get;} [C++] public: _property String* get_FilePath( ); [VB] Public ReadOnly Property FilePath As String [JScript] public function get FilePath( ): String;

Description

[0841] Gets the virtual path of the current request.

[0842] The System.Web.HttpRequest.FilePath does not include the System.Web.HttpRequest.PathInfo trailer. For the URL Http://www.microsoft.com/virdir/page.html/tail, the FilePath is Http://www.microsoft.com/virdir/page.html.

[0843] Files

[0844] ToString

[C#] public HttpFileCollection Files {get;} [C++] public: _property HttpFileCollection* get_Files( ); [VB] Public ReadOnly Property Files As HttpFileCollection [JScript] public function get Files( ): HttpFileCollection;

Description

[0845] Gets the collection of client-uploaded files (Multipart MIME format).

[0846] The file collection is populated only when the HTTP request Content-Type is multipart/form-data.

[0847] Filter

[0848] ToString

[C#] public Stream Filter {get; set;} [C++] public: _property Stream* get_Filter( );public: _property void set_Filter(Stream*); [VB] Public Property Filter As Stream [JScript] public function get Filter( ): Stream;public function set Filter(Stream);

Description

[0849] Gets or sets the filter to use when reading the current input stream.

[0850] Form

[0851] ToString

[C#] public NameValueCollection Form {get;} [C++] public: _property NameValueCollection* get_Form( ); [VB] Public ReadOnly Property Form As NameValueCollection [JScript] public function get Form( ): NameValueCollection;

Description

[0852] Gets a collection of form variables.

[0853] Populated when the HTTP request Content-Type is either application/x-www-form-urlencoded or multipart/form-data.

[0854] Headers

[0855] ToString

[C#] public NameValueCollection Headers {get;} [C++] public: _property NameValueCollection* get_Headers( ); [VB] Public ReadOnly Property Headers As NameValueCollection [JScript] public function get Headers( ): NameValueCollection;

Description

[0856] Gets a collection of HTTP headers.

[0857] HttpMethod

[0858] ToString

[C#] public string HttpMethod {get;} [C++] public: _property String* get_HttpMethod( ); [VB] Public ReadOnly Property HttpMethod As String [JScript] public function get HttpMethod( ): String;

Description

[0859] Gets the HTTP data transfer method (such as GET, POST, or HEAD) used by the client.

[0860] InputStream

[0861] ToString

[C#] public Stream InputStream {get;} [C++] public: _property Stream* get_InputStream( ); [VB] Public ReadOnly Property InputStream As Stream [JScript] public function get InputStream( ): Stream;

Description

[0862] Gets the contents of the incoming HTTP entity body.

[0863] IsAuthenticated

[0864] ToString

[C#] public bool IsAuthenticated {get;} [C++] public: _property bool get_IsAuthenticated( ); [VB] Public ReadOnly Property IsAuthenticated As Boolean [JScript] public function get IsAuthenticated( ): Boolean;

Description

[0865] Gets a value indicating whether the user has been authenticated.

[0866] IsSecureConnection

[0867] ToString

[C#] public bool IsSecureConnection {get;} [C++] public: _property bool get_IsSecureConnection( ); [VB] Public ReadOnly Property IsSecureConnection As Boolean [JScript] public function get IsSecureConnection( ): Boolean;

Description

[0868] Gets a value indicting whether the HTTP connection uses secure sockets (that is, HTTPS).

[0869] Item

[0870] ToString

[C#] public string this[string key] {get;} [C++] public: _property String* get_Item(String* key); [VB] Public Default ReadOnly Property Item(ByVal key As String) As String [JScript] returnValue=HttpRequestObject.Item(key);

Description

[0871] Default HttpRequest indexed property that retrieves a QueryString, Form, Cookies, or ServerVariables collection. This property is read-only. Numerical index to collection members.

[0872] Params

[0873] ToString

[C#] public NameValueCollection Params {get;} [C++] public: _property NameValueCollection* get_Params( ); [VB] Public ReadOnly Property Params As NameValueCollection [JScript] public function get Params( ): NameValueCollection;

Description

[0874] Gets a combined collection of System.Web.HttpRequest.QueryString, System.Web.HttpRequest.Form, System.Web.HttpRequest.ServerVariables, and System.Web.HttpRequest.Cookies items.

[0875] Path

[0876] ToString

[C#] public string Path {get;} [C++] public: _property String* get_Path( ); [VB] Public ReadOnly Property Path As String [JScript] public function get Path( ): String;

Description

[0877] Gets the virtual path of the current request.

[0878] The System.Web.HttpRequest.FilePath does not include the System.Web.HttpRequest.PathInfo trailer. For the URL Http://www.microsoft.com/virdir/page.html/tail, the FilePath is Http://www.microsoft.com/virdir/page.html.

[0879] PathInfo

[0880] ToString

[C#] public string PathInfo {get;} [C++] public: _property String* get_PathInfo( ); [VB] Public ReadOnly Property PathInfo As String [JScript] public function get PathInfo( ): String;

Description

[0881] Gets additional path information for a resource with a URL extension.

[0882] For the URL Http://www.microsoft.com/virdir/page.html/tail, the PathInfo value is /tail.

[0883] PhysicalApplicationPath

[0884] ToString

[C#] public string PhysicalApplicationPath {get;} [C++] public: _property String* get_PhysicalApplicationPath( ); [VB] Public ReadOnly Property PhysicalApplicationPath As String [JScript] public function get PhysicalApplicationPath( ): String;

Description

[0885] Gets the physical file system path of the currently executing server application's root directory.

[0886] PhysicalPath

[0887] ToString

[C#] public string PhysicalPath {get;} [C++] public: _property String* get_PhysicalPath( ); [VB] Public ReadOnly Property PhysicalPath As String [JScript] public function get PhysicalPath( ): String;

Description

[0888] Gets the physical file system path corresponding to the requested URL.

[0889] QueryString

[0890] ToString

[C#] public NameValueCollection QueryString {get;} [C++] public: _property NameValueCollection* get_QueryString( ); [VB] Public ReadOnly Property QueryString As NameValueCollection [JScript] public function get QueryString( ): NameValueCollection;

Description

[0891] Gets the collection of HTTP query string variables.

[0892] RawUrl

[0893] ToString

[C#] public string RawUrl {get;} [C++] public: _property String* get_RawUrl( ); [VB] Public ReadOnly Property RawUrl As String [JScript] public function get RawUrl( ): String;

Description

[0894] Gets the raw URL of the current request.

[0895] The raw URL is defined as the part of the URL following the domain information. In the URL string http://www.microsoft.com/articles/recent.aspx, the raw URL is /articles/recent.aspx. The raw URL includes the query string, if present.

[0896] RequestType

[0897] ToString

[0898] [C#] public string RequestType {get; set;} [C++] public: _property String* get_RequestType( );public: _property void set_RequestType(String*); [VB] Public Property RequestType As String [JScript] public function get RequestType( ): String;public function set RequestType(String);

Description

[0899] Gets or sets the HTTP data transfer method (GET or POST) used by the client.

[0900] ServerVariables

[0901] ToString

[0902] [C#] public NameValueCollection ServerVariables {get;} [C++] public: _property NameValueCollection* get_ServerVariables( ); [VB] Public ReadOnly Property ServerVariables As NameValueCollection [JScript] public function get ServerVariables( ): NameValueCollection;

Description

[0903] Gets a collection of web server variables.

[0904] TotalBytes

[0905] ToString

[C#] public int TotalBytes {get;} [C++] public: _property int get_TotalBytes( ); [VB] Public ReadOnly Property TotalBytes As Integer [JScript] public function get TotalBytes( ): int;

Description

[0906] Gets the number of bytes in the current input stream.

[0907] Url

[0908] ToString

[C#] public Uri Url {get;} [C++] public: _property Uri* get_Url( ); [VB] Public ReadOnly Property Url As Uri [JScript] public function get Url( ): Uri;

Description

[0909] Gets Information about the URL of the current request.

[0910] UrlReferrer

[0911] ToString

[C#] public Uri UrlReferrer {get;} [C++] public: _property Uri* get_UrlReferrer( ); [VB] Public ReadOnly Property UrlReferrer As Uri [JScript] public function get UrlReferrer( ): Uri;

Description

[0912] Gets information about the URL of the client's previous request that linked to the current URL.

[0913] UserAgent

[0914] ToString

[C#] public string UserAgent {get;} [C++] public: _property String* get_UserAgent( ); [VB] Public ReadOnly Property UserAgent As String [JScript] public function get UserAgent( ): String;

Description

[0915] Gets the raw user agent string of the client browser.

[0916] UserHostAddress

[0917] ToString

[C#] public string UserHostAddress {get;} [C++] public: _property String* get_UserHostAddress( ); [VB] Public ReadOnly Property UserHostAddress As String [JScript] public function get UserHostAddress( ): String;

Description

[0918] Gets the IP host address of the remote client.

[0919] UserHostName

[0920] ToString

[C#] public string UserHostName {get;} [C++] public: _property String* get_UserHostName( ); [VB] Public ReadOnly Property UserHostName As String [JScript] public function get UserHostName( ): String;

Description

[0921] Gets the DNS name of the remote client.

[0922] UserLanguages

[0923] ToString

[C#] public string[ ] UserLanguages {get;} [C++] public: _property String* get_UserLanguages( ); [VB] Public ReadOnly Property UserLanguages As String ( ) [JScript] public function get UserLanguages( ): String[ ];

Description

[0924] Gets a sorted string array of client language preferences.

[0925] BinaryRead

[C#] public byte[ ] BinaryRead(int count); [C++] public: unsigned char BinaryRead(int count) _gc[ ]; [VB] Public Function BinaryRead(ByVal count As Integer) As Byte( ) [JScript] public function BinaryRead(count: int): Byte[ ];

Description

[0926] Performs a binary read of a specified number of bytes from the current input stream.

Return Value: A byte array.

[0927] The BinaryRead method is provided for compatibility with previous versions of ASP. Number of bytes to read.

[0928] MapImageCoordinates

[0929] [C#] public int[ ] MapImageCoordinates(string imageFieldName); [C++] public: int MapImageCoordinates(String* imageFieldName) _gc[ ]; [VB] Public Function MapImageCoordinates(ByVal imageFieldName As String) As Integer( ) [JScript] public function MapImageCoordinates(imageFieldName: String): int[ ];

Description

[0930] Maps an incoming image-field form parameter to appropriate x/y coordinate values.

Return Value: A two-dimensional array of integers. A string reference to a form image map.

[0931] MapPath

[0932] [C#] public string MapPath(string virtualPath); [C++]public: String* MapPath(String* virtualPath); [VB] Public Function MapPath(ByVal virtualPath As String) As String [JScript] public function MapPath(virtualPath: String): String; Maps the virtual path in the requested URL to a physical path on the server for the current request.

Description

[0933] Maps the specified virtual path to a physical path. The virtual path (absolute or relative) for the current request.

[0934] MapPath

[0935] [C#] public string MapPath(string virtualPath, string baseVirtualDir, bool allowCrossAppMapping); [C++] public: String* MapPath(String* virtualPath, String* baseVirtualDir, bool allowCrossAppMapping); [VB] Public Function MapPath(ByVal virtualPath As String, ByVal baseVirtualDir As String, ByVal allowCrossAppMapping As Boolean) As String [JScript] public function MapPath(virtualPath: String, baseVirtualDir: String, allowCrossAppMapping: Boolean): String;

Description

[0936] Maps the specified virtual path to a physical path. The virtual path (absolute or relative) for the current request. The virtual base directory path used for relative resolution. If true, the virtualPath may belong to another application.

[0937] SaveAs

[0938] [C#] public void SaveAs(string filename, bool includeHeaders); [C++] public: void SaveAs(String* filename, bool includeHeaders); [VB] Public Sub SaveAs(ByVal filename As String, ByVal includeHeaders As Boolean) [JScript] public function SaveAs(filename: String, includeHeaders: Boolean);

Description

[0939] Saves an HTTP request to disk.

[0940] Saving the request context to disk can be useful in debugging. A string reference to a physical drive path. A Boolean value specifying whether an HTTP header should be saved to disk.

[0941] HttpResponse class (System.Web)

[0942] ToString

Description

[0943] Encapsulates HTTP response information from an ASP.NET operation.

[0944] The methods and properties of the HttpResponse class are exposed through ASP.NET's intrinsic Response object.

[0945] HttpResponse

[0946] Example Syntax:

[0947] ToString

[C#] public HttpResponse(TextWriter writer); [C++] public: HttpResponse(TextWriter* writer); [VB] Public Sub New(ByVal writer As TextWriter) [JScript] public function HttpResponse(writer: TextWriter);

Description

[0948] Initializes a new instance of the HttpResponse class. A TextWriter object enabling custom HTTP output.

[0949] Buffer

[0950] ToString

[C#] public bool Buffer {get; set;} [C++] public: _property bool get_Buffer( );public: _property void set_Buffer(bool); [VB] Public Property Buffer As Boolean [JScript] public function get Buffer( ): Boolean;public function set Buffer(Boolean);

Description

[0951] Gets or sets a value indicating whether to buffer output and send it after the entire response is finished processing.

[0952] System.Web.HttpResponse.Buffer has been deprecated in favor of System.Web.HttpResponse.BufferOutput and is provided only for compatibility with previous versions of ASP. With ASP.NET, use System.Web.HttpResponse.BufferOutput.

[0953] BufferOutput

[0954] ToString

[0955] [C#] public bool BufferOutput {get; set;} [C++] public: _property bool get_BufferOutput( );public: _property void set_BufferOutput(bool); [VB] Public Property BufferOutput As Boolean [JScript] public function get BufferOutput( ): Boolean;public function set BufferOutput(Boolean);

Description

[0956] Gets or sets a value indicating whether to buffer output and send it after the entire page is finished processing.

[0957] Cache

[0958] ToString

[C#] public HttpCachePolicy Cache {get;} [C++] public: _property HttpCachePolicy* get_Cache( ); [VB] Public ReadOnly Property Cache As HttpCachePolicy [JScript] public function get Cache( ): HttpCachePolicy;

Description

[0959] Gets the caching policy (expiration time, privacy, vary clauses) of a Web page.

[0960] CacheControl

[0961] ToString

[0962] [C#] public string CacheControl {get; set;} [C++] public: _property String* get_CacheControl( );public: _property void set_CacheControl(String*); [VB] Public Property CacheControl As String [JScript] public function get CacheControl( ): String;public function set CacheControl(String);

Description

[0963] Sets the Cache-Control HTTP header to Public or Private.

[0964] The values for Private and Public are strings and must be enclosed in quotation marks (“”).

[0965] Charset

[0966] ToString

[0967] [C#] public string Charset {get; set;} [C++] public: _property String* get_Charset( );public: _property void set_Charset(String*); [VB] Public Property Charset As String [JScript] public function get Charset( ): String;public function set Charset(String);

Description

[0968] Gets or sets the HTTP character set of the output stream.

[0969] Charset can be set to null to suppress the Content-Type header.

[0970] ContentEncoding

[0971] ToString

[0972] [C#] public Encoding ContentEncoding {get; set;} [C++] public: _property Encoding* get_ContentEncoding( );public: _property void set_ContentEncoding(Encoding*); [VB] Public Property ContentEncoding As Encoding [JScript] public function get ContentEncoding( ): Encoding;public function set ContentEncoding(Encoding);

Description

[0973] Gets or sets the HTTP character set of the output stream.

[0974] ContentType

[0975] ToString

[0976] [C#] public string ContentType {get; set;} [C++] public: _property String* get_ContentType( );public: _property void set_ContentType(String*); [VB] Public Property ContentType As String [JScript] public function get ContentType( ): String;public function set ContentType(String);

Description

[0977] Gets or sets the HTTP MIME type of the output stream.

[0978] The following example takes action if the content type of the output is not “Text/HTML”.

[0979] Cookies

[0980] ToString

[C#] public HttpCookieCollection Cookies {get;} [C++] public: _property HttpCookieCollection* get_Cookies( ); [VB] Public ReadOnly Property Cookies As HttpCookieCollection [JScript] public function get Cookies( ): HttpCookieCollection;

Description

[0981] Gets the response cookie collection.

[0982] ASP.NET includes two intrinsic cookie collections. The collection accessed through Cookies contains cookies transmitted by the client to the server in the System.Web.HttpRequest.Cookies header. The collection accessed through System.Web.HttpResponse.Cookies contains cookies generated on the server and transmitted to the client in the Set-Cookie header.

[0983] Expires

[0984] ToString

[C#] public int Expires {get; set;} [C++] public: _property int get_Expires( );public: _property void set_Expires(int); [VB] Public Property Expires As Integer [JScript] public function get Expires( ): int;public function set Expires(int);

Description

[0985] Gets or sets the number of minutes before a page cached on a browser expires. If the user returns to the same page before it expires, the cached version is displayed.

[0986] The Expires, System.Web.HttpResponse.ExpiresAbsolute and System.Web.HttpResponse.CacheControl properties have been deprecated in favor of the methods of the System.Web.HttpCachePolicy class available through the System.Web.HttpResponse.Cache intrinsic object to control the IIS output cache and client caches.

[0987] ExpiresAbsolute

[0988] ToString

[0989] [C#] public DateTime ExpiresAbsolute {get; set;} [C++] public: _property DateTime get_ExpiresAbsolute( );public: _property void set_ExpiresAbsolute(DateTime); [VB] Public Property ExpiresAbsolute As DateTime [JScript] public function get ExpiresAbsolute( ): DateTime;public function set ExpiresAbsolute(DateTime);

Description

[0990] Gets or sets the absolute date and time at which to remove cached information from the cache.

[0991] The ExpiresAbsolute, System.Web.HttpResponse.Expires and System.Web.HttpResponse.CacheControl properties have been deprecated in 11 favor of the methods of the System.Web.HttpCachePolicy class available through the System.Web.HttpResponse.Cache intrinsic object to control the IIS output cache and client caches.

[0992] Filter

[0993] ToString

[C#] public Stream Filter {get; set;} [C++] public: _property Stream* get_Filter( );public: _property void set_Filter(Stream*); [VB] Public Property Filter As Stream [JScript] public function get Filter( ): Stream;public function set Filter(Stream);

Description

[0994] Gets or sets a wrapping filter object used to modify the HTTP entity body before transmission.

[0995] When you create a Stream object and set the Response.Filter property to the Stream object, all HTTP output sent by Response.Write passes through the filter.

[0996] IsClientConnected

[0997] ToString

[C#] public bool IsClientConnected {get;} [C++] public: _property bool get_IsClientConnected( ); [VB] Public ReadOnly Property IsClientConnected As Boolean [JScript] public function get IsClientConnected( ): Boolean;

Description

[0998] Gets a value indicating whether the client is still connected to the server.

[0999] Output

[1000] ToString

[C#] public TextWriter Output {get;} [C++] public: _property TextWriter* get_Output( ); [VB] Public ReadOnly Property Output As TextWriter [JScript] public function get Output( ): TextWriter;

Description

[1001] Enables output of text to the outgoing HTTP response stream.

[1002] OutputStream

[1003] ToString

[C#] public Stream OutputStream {get;} [C++] public: _property Stream* get_OutputStream( ); [VB] Public ReadOnly Property OutputStream As Stream [JScript] public function get OutputStream( ): Stream;

Description

[1004] Enables binary output to the outgoing HTTP content body.

[1005] Status

[1006] ToString

[C#] public string Status {get; set;} [C++] public: _property String* get_Status( );public: _property void set_Status(String*); [VB] Public Property Status As String [JScript] public function get Status( ): String;public function set Status(String);

Description

[1007] Sets the Status line that is returned to the client.

[1008] System.Web.HttpResponse.Status has been deprecated in favor of System.Web.HttpResponse.Status

Description and is provided only for compatibility with previous versions of ASP. With ASP.NET, use System.Web.HttpResponse.Status

Description instead.

[1009] StatusCode

[1010] ToString

[1011] [C#] public int StatusCode {get; set;} [C++] public: _property int get_StatusCode( );public: _property void set_StatusCode(int); [VB] Public Property StatusCode As Integer [JScript] public function get StatusCode( ): int;public function set StatusCode(int);

Description

[1012] Gets or sets the HTTP status code of the output returned to the client.

[1013] StatusDescription

[1014] ToString

[1015] [C#] public string StatusDescription {get; set;} [C++] public: _property String* get_StatusDescription( );public: _property void set_StatusDescription(String*); [VB] Public Property StatusDescription As String [JScript] public function get StatusDescription( ): String;public function set StatusDescription(String);

Description

[1016] Gets or sets the HTTP status string of the output returned to the client.

[1017] SuppressContent

[1018] ToString

[1019] [C#] public bool SuppressContent {get; set;} [C++] public: _property bool get_SuppressContent( );public: _property void set_SuppressContent(bool); [VB] Public Property SuppressContent As Boolean [JScript] public function get SuppressContent( ): Boolean;public function set SuppressContent(Boolean);

Description

[1020] Gets or sets a value indicating whether to send HTTP content to the client.

[1021] AddCacheItemDependencies

[1022] [C#] public void AddCacheItemDependencies(ArrayList cacheKeys); [C++] public: void AddCacheItemDependencies(ArrayList* cacheKeys); [VB] Public Sub AddCacheItemDependencies(ByVal cacheKeys As ArrayList) [JScript] public function AddCacheItemDependencies(cacheKeys: ArrayList);

[1023] AddCacheItemDependency

[1024] [C#] public void AddCacheItemDependency(string cacheKey); [C++] public: void AddCacheItemDependency(String* cacheKey); [VB] Public Sub AddCacheItemDependency(ByVal cacheKey As String) [JScript] public function AddCacheItemDependency(cacheKey: String);

[1025] AddFileDependencies

[1026] [C#] public void AddFileDependencies(ArrayList filenames); [C++] public: void AddFileDependencies(ArrayList* filenames); [VB] Public Sub AddFileDependencies(ByVal filenames As ArrayList) [JScript] public function AddFileDependencies(filenames: ArrayList);

Description

[1027] Adds a group of file names to the collection of file names on which the current response is dependent. The collection of files to add.

[1028] AddFileDependency

[C#] public void AddFileDependency(string filename); [C++] public: void AddFileDependency(String* filename); [VB] Public Sub AddFileDependency(ByVal filename As String) [JScript] public function AddFileDependency(filename: String);

Description

[1029] Adds a single file name to the collection of file names on which the current response is dependent. The name of the file to add.

[1030] AddHeader

[1031] [C#] public void AddHeader(string name, string value); [C++] public: void AddHeader(String* name, String* value); [VB] Public Sub AddHeader(ByVal name As String, ByVal value As String) [JScript] public function AddHeader(name: String, value: String);

Description

[1032] Adds an HTTP header to the output stream.

[1033] AddHeader is the same as System.Web.HttpResponse.AppendHeader(System.Web.HttpResponseHeader) and is provided only for compatibility with previous versions of ASP. With ASP.NET, use AppendHeader. The name of the HTTP header to add value to. The string to add to the header.

[1034] AppendCookie

[C#] public void AppendCookie(HttpCookie cookie); [C++] public: void AppendCookie(HttpCookie* cookie); [VB] Public Sub AppendCookie(ByVal cookie As HttpCookie) [JScript] public function AppendCookie(cookie: HttpCookie);

Description

[1035] Adds an HTTP cookie to the intrinsic cookie collection. The cookie to add to the output stream.

[1036] AppendHeader

[1037] [C#] public void AppendHeader(string name, string value); [C++] public: void AppendHeader(String* name, String* value); [VB] Public Sub AppendHeader(ByVal name As String, ByVal value As String) [JScript] public function AppendHeader(name: String, value: String);

Description

[1038] Adds an HTTP header to the output stream.

[1039] If you use the System.Web.HttpResponse.AppendHeader(System.Web.HttpResponseHeader) method to send cache-specific headers and at the same time use the cache object model ( System.Web.HttpResponse.Cache ) to set cache policy, HTTP response headers pertaining to caching (Cache-Control, Expires, Last-Modified, Pragma, and Vary) might be deleted when the cache object model is used. This behavior enables ASP.NET to maintain the most restrictive settings. For example, consider a page that includes user controls. If those controls have conflicting cache policies, the most restrictive cache policy will be used. If one user control sets the header “Cache-Control: Public” and another sets the more restrictive header “Cache-Control: Private” via calls to System.Web.HttpCachePolicy.SetCacheability(System.Web.HttpCacheability), then the “Cache-Control: Private” header will be sent with the response. The name of the HTTP header to add to the output stream. The string to append to the header.

[1040] AppendToLog

[C#] public void AppendToLog(string param); [C++] public: void AppendToLog(String* param); [VB] Public Sub AppendToLog(ByVal param As String) [JScript] public function AppendToLog(param: String);

Description

[1041] Adds custom log information to the IIS log file. The text to add to the log file.

[1042] ApplyAppPathModifier

[1043] [C#] public string ApplyAppPathModifier(string virtualPath); [C++] public: String* ApplyAppPathModifier(String* virtualPath); [VB] Public Function ApplyAppPathModifier(ByVal virtualPath As String) As String [JScript] public function ApplyAppPathModifier(virtualPath: String): String;

Description

[1044] BinaryWrite

[C#] public void BinaryWrite(byte[ ] buffer); [C++] public: void BinaryWrite(unsigned char buffer _gc[ ]); [VB] Public Sub BinaryWrite(ByVal buffers As Byte) [JScript] public function BinaryWrite(buffer: Byte[ ]);

Description

[1045] Writes a string of binary characters to the HTTP output stream. The bytes to write to the output stream.

[1046] Clear

[C#] public void Clear( ); [C++] public: void Clear( ); [VB] Public Sub Clear( ) [JScript] public function Clear( );

Description

[1047] Clears all content output from the buffer stream.

[1048] ClearContent

[C#] public void ClearContent( ); [C++] public: void ClearContent( ); [VB] Public Sub ClearContent( ) [JScript] public function ClearContent( );

Description

[1049] Clears all content output from the buffer stream.

[1050] ClearHeaders

[C#] public void ClearHeaders( ); [C++] public: void ClearHeaders( ); [VB] Public Sub ClearHeaders( ) [JScript] public function ClearHeaders( );

Description

[1051] Clears all headers from the buffer stream.

[1052] Close

[C#] public void Close( ); [C++] public: void Close( ); [VB] Public Sub Close( ) [JScript] public function Close( );

Description

[1053] Closes the socket connection to a client.

[1054] End

[C#] public void End( ); [C++] public: void End( ); [VB] Public Sub End( ) [JScript] public function End( );

Description

[1055] Sends all currently buffered output to the client, stops execution of the page, and fires the Application_EndRequest event.

[1056] Flush

[C#] public void Flush( ); [C++] public: void Flush( ); [VB] Public Sub Flush( ) [JScript] public function Flush( );

Description

[1057] Sends all currently buffered output to the client.

[1058] Forces all currently buffered output to be sent to the client.

[1059] Pics

[C#] public void Pics(string value); [C++] public: void Pics(String* value); [VB] Public Sub Pics(ByVal value As String) [JScript] public function Pics(value: String);

Description

[1060] Appends a PICS-Label HTTP header to the output stream.

[1061] Platform for Internet Content Selection (PICS) is a World Wide Web Consortium (W3C) standard for content labeling. PICS is essentially a language for creating a ratings system. The string to add to the PICS-Label header.

[1062] Redirect

[C#] public void Redirect(string url); [C++] public: void Redirect(String* url); [VB] Public Sub Redirect(ByVal url As String) [JScript] public function Redirect(url: String);

Description

[1063] Redirects a client to a new URL. The target location.

[1064] Redirect

[1065] [C#] public void Redirect(string url, bool endResponse); [C++] public: void Redirect(String* url, bool endResponse); [VB] Public Sub Redirect(ByVal url As String, ByVal endResponse As Boolean) [JScript] public function Redirect(url: String, endResponse: Boolean); Redirects a client to a new URL.

[1066] RemoveOutputCacheItem

[1067] [C#] public static void RemoveOutputCacheItem(string path); [C++] public: static void RemoveOutputCacheItem(String* path); [VB] Public Shared Sub RemoveOutputCacheItem(ByVal path As String) [JScript] public static function RemoveOutputCacheItem(path: String);

[1068] SetCookie

[C#] public void SetCookie(HttpCookie cookie); [C++] public: void SetCookie(HttpCookie* cookie); [VB] Public Sub SetCookie(ByVal cookie As HttpCookie) [JScript] public function SetCookie(cookie: HttpCookie);

Description

[1069] Updates an existing cookie in the cookie collection.

[1070] Write

[C#] public void Write(char ch); [C++] public: void Write(_wchar_t ch); [VB] Public Sub Write(ByVal ch As Char) [JScript] public function Write(ch: Char);

Description

[1071] Writes a character to an HTTP output content stream. The character to write to the HTTP output stream.

[1072] Write

[C#] public void Write(object obj); [C++] public: void Write(Object* obj); [VB] Public Sub Write(ByVal obj As Object) [JScript] public function Write(obj: Object);

Description

[1073] Writes an Object to an HTTP output content stream. The Object to write to the HTTP output stream.

[1074] Write

[C#] public void Write(string s); [C++] public: void Write(String* s); [VB] Public Sub Write(ByVal s As String) [JScript] public function Write(s: String); Writes information to an HTTP output content stream.

Description

[1075] Writes a string to an HTTP output content stream. The string to write to the HTTP output stream.

[1076] Write

[1077] [C#] public void Write(char[ ] buffer, int index, int count); [C++] public: void Write(_wchar_t buffer _gc[ ], mt index, int count); [VB] Public Sub Write(ByVal buffers As Char, ByVal index As Integer, ByVal count As Integer) [JScript] public function Write(buffer: Char[ ], index: int, count: int);

Description

[1078] Writes an array of characters to an HTTP output content stream. The character array to write. The position in the character array where writing starts. The number of characters to write, beginning at index.

[1079] WriteFile

[1080] [C#] public void WriteFile(string filename); [C++] public: Void WriteFile(String* filename); [VB] Public Sub WriteFile(ByVal filename As String) [JScript] public function WriteFile(filename: String); Writes the specified file directly to an HTTP content output stream.

Description

[1081] Writes the specified file directly to an HTTP content output stream. The name of the file to write to the HTTP output.

[1082] WriteFile

[1083] [C#] public void WriteFile(string filename, bool readIntoMemory); [C++] public: void WriteFile(String* filename, bool readIntoMemory); [VB] Public Sub WriteFile(ByVal filename As String, ByVal readIntoMemory As Boolean) [JScript] public function WriteFile(filename: String, readIntoMemory: Boolean);

Description

[1084] Writes the contents of the specified file into a memory block. The name of the file to write into a memory block. Indicates whether the file will be written into a memory block.

[1085] WriteFile

[1086] [C#] public void WriteFile(IntPtr fileHandle, long offset, long size); [C++] public: void WriteFile(IntPtr fileHandle, _int64 offset, _int64 size); [VB] Public Sub WriteFile(ByVal fileHandle As IntPtr, ByVal offset As Long, ByVal size As Long) [JScript] public function WriteFile(fileHandle: IntPtr, offset: long, size: long);

Description

[1087] Writes the specified file directly to an HTTP content output stream. The file handle of the file to write to the HTTP output stream. The byte position in the file where writing will start. The number of bytes to write to the output stream.

[1088] WriteFile

[1089] [C#] public void WriteFile(string filename, long offset, long size); [C++] public: void WriteFile(String* filename, _int64 offset, _int64 size); [VB] Public Sub WriteFile(ByVal filename As String, ByVal offset As Long, ByVal size As Long) [JScript] public function WriteFile(filename: String, offset: long, size: long);

Description

[1090] Writes the specified file directly to an HTTP content output stream. The name of the file to write to the HTTP output stream. The byte position in the file where writing will start. The number of bytes to write to the output stream.

[1091] HttpRuntime class (System.Web)

[1092] WriteFile

Description

[1093] Provides a set of ASP.NET runtime services.

[1094] HttpRuntime

[1095] Example Syntax:

[1096] WriteFile

[C#] public HttpRuntime( ); [C++] public: HttpRuntime( ); [VB] Public Sub New( ) [JScript] public function HttpRuntime( );

[1097] AppDomainAppId

[1098] WriteFile

[C#] public static string AppDomainAppId {get;} [C++] public: _property static String* get_AppDomainAppId( ); [VB] Public Shared ReadOnly Property AppDomainAppId As String [JScript] public static function get AppDomainAppId( ): String;

Description

[1099] AppDomainAppPath

[1100] WriteFile

[C#] public static string AppDomainAppPath {get;} [C++] public: _property static String* get_AppDomainAppPath( ); [VB] Public Shared ReadOnly Property AppDomainAppPath As String [JScript] public static function get AppDomainAppPath( ): String;

Description

[1101] AppDomainAppVirtualPath

[1102] WriteFile

[1103] [C#] public static string AppDomainAppVirtualPath {get;} [C++] public: _property static String* get_AppDomainAppVirtualPath( ); [VB] Public Shared ReadOnly Property AppDomainAppVirtualPath As String [JScript] public static function get AppDomainAppVirtualPath( ): String;

Description

[1104] AppDomainId

[1105] WriteFile

[C#] public static string AppDomainId {get;} [C++] public: _property static String* get_AppDomainId( ); [VB] Public Shared ReadOnly Property AppDomainId As String [JScript] public static function get AppDomainId( ): String;

Description

[1106] AspInstallDirectory

[1107] WriteFile

[1108] [C#] public static string AspInstallDirectory {get;} [C++] public: _property static String* get_AspInstallDirectory( ); [VB] Public Shared ReadOnly Property AspInstallDirectory As String [JScript] public static function get AspInstallDirectory( ): String;

Description

[1109] BinDirectory

[1110] WriteFile

[C#] public static string BinDirectory {get;} [C++] public: _property static String* get_BinDirectory( ); [VB] Public Shared ReadOnly Property BinDirectory As String [JScript] public static function get BinDirectory( ): String;

Description

[1111] Cache

[1112] WriteFile

[C#] public static Cache Cache {get;} [C++] public: _property static Cache* get_Cache( ); [VB] Public Shared ReadOnly Property Cache As Cache [JScript] public static function get Cache( ): Cache;

Description

[1113] Provides access to the cache.

[1114]

[1115] ClrInstallDirectory

[1116] WriteFile

[1117] [C#] public static string ClrInstallDirectory {get;} [C++] public: _property static String* get_ClrInstallDirectory( ); [VB] Public Shared ReadOnly Property ClrInstallDirectory As String [JScript] public static function get ClrInstallDirectory( ): String;

Description

[1118] CodegenDir

[1119] WriteFile

[C#] public static string CodegenDir {get;} [C++] public: _property static String* get_CodegenDir( ); [VB] Public Shared ReadOnly Property CodegenDir As String [JScript] public static function get CodegenDir( ): String;

Description

[1120] IsOnUNCShare

[1121] WriteFile

[C#] public static bool IsOnUNCShare {get;} [C++] public: _property static bool get_IsOnUNCShare( ); [VB] Public Shared ReadOnly Property IsOnUNCShare As Boolean [JScript] public static function get IsOnUNCShare( ): Boolean;

Description

[1122] MachineConfigurationDirectory

[1123] WriteFile

[1124] [C#] public static string MachineConfigurationDirectory {get;} [C++] public: _property static String* get_MachineConfigurationDirectory( ); [VB] Public Shared ReadOnly Property MachineConfigurationDirectory As String [JScript] public static function get MachineConfigurationDirectory( ): String;

Description

[1125] Close

[C#] public static void Close( ); [C++] public: static void Close( ); [VB] Public Shared Sub Close( ) [JScript] public static function Close( );

Description

[1126] Removes all items from the cache and shuts down the runtime.

[1127] ProcessRequest

[1128] [C#] public static void ProcessRequest(HttpWorkerRequest wr); [C++] public: static void ProcessRequest(HttpWorkerRequest* wr); [VB] Public Shared Sub ProcessRequest(ByVal wr As HttpWorkerRequest) [JScript] public static function ProcessRequest(wr: HttpWorkerRequest);

Description

[1129] The method that drives all ASP.NET Web processing execution. HttpWorkerRequest object

[1130] HttpServerUtility class (System.Web)

[1131] ToString

Description

[1132] Provides helper methods for processing Web requests.

[1133] The methods and properties of the System.Web.HttpServerUtility class are exposed through ASP.NET's intrinsic System.Web.HttpContext.Server object.

[1134] MachineName

[1135] ToString

[C#] public string MachineName {get;} [C++] public: _property String* get_MachineName( ); [VB] Public ReadOnly Property MachineName As String [JScript] public function get MachineName( ): String;

Description

[1136] Gets the server machine name.

[1137] ScriptTimeout

[1138] ToString

[1139] [C#] public int ScriptTimeout {get; set;} [C++] public: _property int get_ScriptTimeout( );public: _property void set_ScriptTimeout(int); [VB] Public Property ScriptTimeout As Integer [JScript] public function get ScriptTimeout( ): int;public function set ScriptTimeout(int);

Description

[1140] Gets and sets the request time-out in seconds.

[1141] ClearError

[C#] public void ClearError( ); [C++] public: void ClearError( ); [VB] Public Sub ClearError( ) [JScript] public function ClearError( );

Description

[1142] Clears the previous exception.

[1143] CreateObject

[C#] public object CreateObject(string progID); [C++] public: Object* CreateObject(String* progID); [VB] Public Function CreateObject(ByVal progID As String) As Object [JScript] public function CreateObject(progID: String): Object;

Description

[1144] Creates a server instance of a COM object identified by the object's Programmatic Identifier (ProgID).

Return Value: The new object. The class or type of object to be instantiated.

[1145] CreateObject

[C#] public object CreateObject(Type type); [C++] public: Object* CreateObject(Type* type); [VB] Public Function CreateObject(ByVal type As Type) As Object [JScript] public function CreateObject(type: Type): Object;

Description

[1146] Instantiates a classic COM object identified via a Type.

[1147] CreateObjectFromClsid

[1148] [C#] public object CreateObjectFromClsid(string clsid); [C++] public: Object* CreateObjectFromClsid(String* clsid); [VB] Public Function CreateObjectFromClsid(ByVal clsid As String) As Object [JScript] public function CreateObjectFromClsid(clsid: String): Object;

Description

[1149] Creates a server instance of a COM object identified by the object's class identifier (CLSID).

Return Value: The new object. The class identifier of the object to be instantiated.

[1150] Execute

[C#] public void Execute(string path); [C++] public: void Execute(String* path); [VB] Public Sub Execute(ByVal path As String) [JScript] public function Execute(path: String); Executes a request to another page.

Description

[1151] Executes a request to another page using the specified URL path to the page.

[1152] The System.Web.HttpServerUtility.Execute(System.String) method continues execution of the original page after execution of the new page is completed. The System.Web.HttpServerUtility.Transfer(System.String,System.Boolean) method unconditionally transfers execution to another page. The URL path of the new request.

[1153] Execute

[1154] [C#] public void Execute(string path, TextWriter writer); [C++] public: void Execute(String* path, TextWriter* writer); [VB] Public Sub Execute(ByVal path As String, ByVal writer As TextWriter) [JScript] public function Execute(path: String, writer: TextWriter);

Description

[1155] Executes a request to another page using the specified URL path to the page. A System.IO.TextWriter captures output from the page.

[1156] The System.Web.HttpServerUtility.Execute(System.String) method continues execution of the original page after execution of the new page is completed. The System.Web.HttpServerUtility.Transfer(System.String,System.Boolean) method unconditionally transfers execution to another page. The URL path of the new request. The System.IO.TextWriter to capture the output.

[1157] GetLastError

[C#] public Exception GetLastError( ); [C++] public: Exception* GetLastError( ); [VB] Public Function GetLastError( ) As Exception [JScript] public function GetLastError( ): Exception;

Description

[1158] Returns the previous exception.

Return Value: The previous exception that was thrown.

[1159] HtmlDecode

[1160] [C#] public string HtmlDecode(string s); [C++] public: String* HtmlDecode(String* s); [VB] Public Function HtmlDecode(ByVal s As String) As String [JScript] public function HtmlDecode(s: String): String; Decodes a string that has been encoded to eliminate illegal HTML characters.

Description

[1161] Decodes an HTML-encoded string and returns the decoded string.

Return Value: The decoded text.

[1162] URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot cannot be used in ASP.NET pages in “” tags or in querystrings where the strings may be sent by a browser in a request string. The HTML string to decode.

[1163] HtmlDecode

[1164] [C#] public void HtmlDecode(string s, TextWriter output); [C++] public: void HtmlDecode(String* s, TextWriter* output); [VB] Public Sub HtmlDecode(ByVal s As String, ByVal output As TextWriter) [JScript] public function HtmlDecode(s: String, output: TextWriter);

Description

[1165] Decodes an HTML-encoded string and sends the resulting output to a System.IO.TextWriter output stream.

[1166] URL encoding ensures that all browsers will correctly transmit text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “” tags or in querystrings where the strings may be sent by a browser in a request string. The HTML string to decode. The System.IO.TextWriter output stream containing the decoded string.

[1167] HtmlEncode

[1168] [C#] public string HtmlEncode(string s); [C++] public: String* HtmlEncode(String* s); [VB] Public Function HtmlEncode(ByVal s As String) As String [JScript] public function HtmlEncode(s: String): String; Encodes a string to be displayed in a browser.

Description

[1169] HTML-encodes a string and returns the encoded string.

Return Value: The HTML-encoded text.

[1170] URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “” tags or in querystrings where the strings may be sent by a browser in a request string. The text string to encode.

[1171] HtmlEncode

[1172] [C#] public void HtmlEncode(string s, TextWriter output); [C++] public: void HtmlEncode(String* s, TextWriter* output); [VB] Public Sub HtmlEncode(ByVal s As String, ByVal output As TextWriter) [JScript] public function HtmlEncode(s: String, output: TextWriter);

Description

[1173] HTML-encodes a string and sends the resulting output to a System.IO.TextWriter output stream.

[1174] HTML encoding ensures that text will be correctly displayed in the browser, not interpreted by the browser as HTML. For example, if a text string contains “<” or “>” characters, the browser would interpret these characters as part of HTML tags. The HTML encoding of these two characters is “<” and “>”, respectively, which causes the browser to display the angle brackets correctly. The string to encode. The System.IO.TextWriter output stream containing the encoded string.

[1175] MapPath

[C#] public string MapPath(string path); [C++] public: String* MapPath(String* path); [VB] Public Function MapPath(ByVal path As String) As String [JScript] public function MapPath(path: String): String;

Description

[1176] Returns the physical file path that corresponds to the specified virtual path on the Web server.

Return Value: The physical file path that corresponds to path. The virtual path on the Web server.

[1177] Transfer

[C#] public void Transfer(string path); [C++] public: void Transfer(String* path); [VB] Public Sub Transfer(ByVal path As String) [JScript] public function Transfer(path: String);

Description

[1178] Terminates execution of the current page and begins execution of a new page using the specified URL path to the page. The URL path of the new page on the server to execute.

[1179] Transfer

[1180] [C#] public void Transfer(string path, bool preserveForm); [C++] public: void Transfer(String* path, bool preserveForm); [VB] Public Sub Transfer(ByVal path As String, ByVal preserveForm As Boolean) [JScript] public function Transfer(path: String, preserveForm: Boolean); Terminates execution of the current page and begins execution of a new page.

Description

[1181] Terminates execution of the current page and begins execution of a new page using the specified URL path to the page. Specifies whether to clear the System.Web.HttpRequest.QueryString and System.Web.HttpRequest.Form collections. The URL path of the new page on the server to execute. If true, the QueryString and Form collections are preserved. If false, they are cleared. The default is false.

[1182] UrlDecode

[1183] [C#] public string UrlDecode(string s); [C++] public: String* UrlDecode(String* s); [VB] Public Function UrlDecode(ByVal s As String) As String [JScript] public function UrlDecode(s: String): String; Decodes a string encoded for HTTP transmission and sent to the server in a URL.

Description

[1184] URL-decodes a string and returns the decoded string.

Return Value: The decoded text.

[1185] URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “” tags or in querystrings where the strings may be sent by a browser in a request string. The text string to decode.

[1186] UrlDecode

[1187] [C#] public void UrlDecode(string s, TextWriter output); [C++] public: void UrlDecode(String* s, TextWriter* output); [VB] Public Sub UrlDecode(ByVal s As String, ByVal output As TextWriter) [JScript] public function UrlDecode(s: String, output: TextWriter);

Description

[1188] Decodes an HTML string received in a URL and sends the resulting output to a System.IO.TextWriter output stream. URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “” tags or in querystrings where the strings may be sent by a browser in a request string. The HTML string to decode. The System.IO.TextWriter output stream containing the decoded string.

[1189] UrlEncode

[1190] [C#] public string UrlEncode(string s); [C++] public: String* UrlEncode(String* s); [VB] Public Function UrlEncode(ByVal s As String) As String [JScript] public function UrlEncode(s: String): String; Encodes a string for reliable HTTP transmission from the Web server to a client via the URL.

Description

[1191] URL-encodes a string and returns the encoded string.

Return Value: The URL encoded text.

[1192] URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “” tags or in querystrings where the strings may be sent by a browser in a request string. The text to URL-encode.

[1193] UrlEncode

[1194] [C#] public void UrlEncode(string s, TextWriter output); [C++] public: void UrlEncode(String* s, TextWriter* output); [VB] Public Sub UrlEncode(ByVal s As String, ByVal output As TextWriter) [JScript] public function UrlEncode(s: String, output: TextWriter);

Description

[1195] URL encodes a string and sends the resulting output to a TextWriter output stream.

[1196] URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot be used in ASP.NET pages in “” tags or in querystrings where the strings may be sent by a browser in a request string. The text string to encode. The System.IO.TextWriter output stream containing the encoded string.

[1197] UrlPathEncode

[1198] [C#] public string UrlPathEncode(string s); [C++] public: String* UrlPathEncode(String* s); [VB] Public Function UrlPathEncode(ByVal s As String) As String [JScript] public function UrlPathEncode(s: String): String; Encodes the path portion of a URL string for reliable HTTP transmission from the Web server to a client via the URL.

Description

[1199] URL-encodes the path portion of a URL string and returns the encoded string.

Return Value: The URL encoded text.

[1200] URL encoding ensures that all browsers will correctly transmitted text in URL strings. Characters such as “?”, “&”, “/”, and spaces may be truncated or corrupted by some browsers so those characters cannot cannot be used in ASP.NET pages in “” tags or in querystrings where the strings may be sent by a browser in a request string. The text to URL-encode.

[1201] HttpStaticObjectsCollection class (System.Web)

[1202] UrlPathEncode

Description

[1203] Provides a static objects collection for the System.Web.HttpApplicationState.StaticObjects property.

[1204] HttpStaticObjectsCollection

[1205] Example Syntax:

[1206] UrlPathEncode

[C#] public HttpStaticObjectsCollection( ); [C++] public: HttpStaticObjectsCollection( ); [VB] Public Sub New( ) [JScript] public function HttpStaticObjectsCollection( );

[1207] Count

[1208] UrlPathEncode

[C#] public int Count {get;} [C++] public: _property int get_Count( ); [VB] Public ReadOnly Property Count As Integer [JScript] public function get Count( ): int;

Description

[1209] Gets the number of objects in the collection.

[1210] IsReadOnly

[1211] UrlPathEncode

[C#] public bool IsReadOnly {get;} [C++] public: _property bool get_IsReadOnly( ); [VB] Public ReadOnly Property IsReadOnly As Boolean [JScript] public function get IsReadOnly( ): Boolean;

Description

[1212] Gets a value indicating whether the collection is read-only.

[1213] IsSynchronized

[1214] UrlPathEncode

[C#] public bool IsSynchronized {get;} [C++] public: _property bool get_IsSynchronized( ); [VB] Public ReadOnly Property IsSynchronized As Boolean [JScript] public function get IsSynchronized( ): Boolean;

Description

[1215] Gets a value indicating whether the collection is synchronized (i.e.: thread-safe).

[1216] Item

[1217] UrlPathEncode

[C#] public object this[string name] {get;} [C++] public: _property Object* get_Item(String* name); [VB] Public Default ReadOnly Property Item(ByVal name As String) As Object [JScript] returnValue=HttpStaticObjectsCollectionObject.Item(name);

Description

[1218] Gets the object with the specified name from the collection. The case-insensitive name of the object to get.

[1219] SyncRoot

[1220] UrlPathEncode

[C#] public object SyncRoot {get;} [C++] public: _property Object* get_SyncRoot( ); [VB] Public ReadOnly Property SyncRoot As Object [JScript] public function get SyncRoot( ): Object;

Description

[1221] Gets an object that can be used to synchronize access to the collection.

[1222] Program code should generally perform synchronized operations on the SyncRoot of a collection, not directly on the collection itself. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection object.

[1223] CopyTo

[1224] [C#] public void CopyTo(Array array, int index); [C++] public: _sealed void CopyTo(Array* array, int index); [VB] NotOverridable Public Sub CopyTo(ByVal array As Array, ByVal index As Integer) [JScript] public function CopyTo(array: Array, index: int);

Description

[1225] Copies members of an HttpStaticObjectsCollection into an array. The array to copy the HttpStaticObjectsCollection into. The member of the collection where copying starts.

[1226] GetEnumerator

[C#] public IEnumerator GetEnumerator( ); [C++] public: _sealed IEnumerator* GetEnumerator( ); [VB] NotOverridable Public Function GetEnumerator( ) As IEnumerator [JScript] public function GetEnumerator( ): IEnumerator;

Description

[1227] Returns a dictionary enumerator used for iterating through the key-and-value pairs contained in the collection.

Return Value: The enumerator for the collection.

[1228] GetObject

[C#] public object GetObject(string name); [C++] public: Object* GetObject(String* name); [VB] Public Function GetObject(ByVal name As String) As Object [JScript] public function GetObject(name: String): Object;

Description

[1229] Returns the object with the specified name from the collection. This property is an alternative to the this accessor.

Return Value: An object from the collection. The case-insensitive name of the object to return.

[1230] HttpUnhandledException class (System.Web)

[1231] ToString

Description

[1232] The exception that is thrown when a generic exception occurs.

[1233] HttpUnhandledException

[1234] Example Syntax:

[1235] ToString

[1236] [C#] public HttpUnhandledException(string message, Exception innerException); [C++] public: HttpUnhandledException(String* message, Exception* innerException); [VB] Public Sub New(ByVal message As String, ByVal innerException As Exception) [JScript] public function HttpUnhandledException(message: String, innerException: Exception); Initializes a new instance of the System.Web.HttpUnhandledException class.

Description

[1237] Initializes a new instance of the System.Web.HttpUnhandledException class with the specified error message and inner exception. The message displayed to the client when the exception is thrown. The System.Exception.InnerException, if any, that threw the current exception.

[1238] HttpUnhandledException

[1239] Example Syntax:

[1240] ToString

[1241] [C#] public HttpUnhandledException(string message, string postMessage, Exception innerException); [C++] public: HttpUnhandledException(String* message, String* postMessage, Exception* innerException); [VB] Public Sub New(ByVal message As String, ByVal postMessage As String, ByVal innerException As Exception) [JScript] public function HttpUnhandledException(message: String, postMessage: String, innerException: Exception);

Description

[1242] Initializes a new instance of the HttpUnhandledException class with the specified error messages and inner exception. The message displayed to the client when the exception is thrown. An additional message displayed to the client when the exception is thrown. The System.Exception.InnerException, if any, that threw the current exception.

[1243] ErrorCode

[1244] HelpLink

[1245] HResult

[1246] InnerException

[1247] Message

[1248] Source

[1249] StackTrace

[1250] TargetSite

[1251] HttpUtility class (System.Web)

[1252] ToString

Description

[1253] Provides methods for encoding and decoding URLs when processing Web requests.

[1254] HttpUtility

[1255] Example Syntax:

[1256] ToString

[C#] public HttpUtility( ); [C++] public: HttpUtility( ); [VB] Public Sub New( ) [JScript] public function HttpUtility( );

[1257] HtmlAttributeEncode

[1258] [C#] public static string HtmlAttributeEncode(string s); [C++] public: static String* HtmlAttributeEncode(String* s); [VB] Public Shared Function HtmlAttributeEncode(ByVal s As String) As String [JScript] public static function HtmlAttributeEncode(s: String): String; Minimally converts a string into an HTML-encoded string.

Description

[1259] Minimally converts a string to an HTML-encoded string.

Return Value: The encoded string.

[1260] HtmlAttributeEncode converts only quotes (“) and ampersands (&) to equivalent character entities. It is considerably faster than the System.Web.HttpUtility.HtmlEncode(System.String) methods. The string to encode.

[1261] HtmlAttributeEncode

[1262] [C#] public static void HtmlAttributeEncode(string s, TextWriter output); [C++] public: static void HtmlAttributeEncode(String* s, TextWriter* output); [VB] Public Shared Sub HtmlAttributeEncode(ByVal s As String, ByVal output As TextWriter) [JScript] public static function HtmlAttributeEncode(s: String, output: TextWriter);

Description

[1263] Minimally converts a string into an HTML-encoded string and sends the encoded string to a System.IO.TextWriter output stream.

[1264] HtmlAttributeEncode converts only quotes (“) and ampersands (&) to equivalent character entities. It is considerably faster than the System.Web.HttpUtility.HtmlEncode(System.String) methods. The string to encode A System.IO.TextWriter output stream.

[1265] HtmlDecode

[1266] [C#] public static string HtmlDecode(string s); [C++] public: static String* HtmlDecode(String* s); [VB] Public Shared Function HtmlDecode(ByVal s As String) As String [JScript] public static function HtmlDecode(s: String): String; Converts a string that has been HTML-encoded for HTTP transmission into a decoded string.

Description

[1267] Converts a string that has been HTML-encoded for HTTP transmission into a decoded string.

Return Value: The decoded string.

[1268] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission. The string to decode.

[1269] HtmlDecode

[1270] [C#] public static void HtmlDecode(string s, TextWriter output); [C++] public: static void HtmlDecode(String* s, TextWriter* output); [VB] Public Shared Sub HtmlDecode(ByVal s As String, ByVal output As TextWriter) [JScript] public static function HtmlDecode(s: String, output: TextWriter);

Description

[1271] Converts a string that has been HTML-encoded into a decoded string, and sends the decoded string to a System.IO.TextWriter output stream.

[1272] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission. The string to decode. A System.IO.TextWriter stream of output.

[1273] HtmlEncode

[1274] [C#] public static string HtmlEncode(string s); [C++] public: static String* HtmlEncode(String* s); [VB] Public Shared Function HtmlEncode(ByVal s As String) As String [JScript] public static function HtmlEncode(s: String): String; Converts a string into an HTML-encoded string for reliable HTTP transmission from the Web server to a client.

Description

[1275] Converts a string to an HTML-encoded string for reliable HTTP transmission from the Web server to a client.

Return Value: The encoded string.

[1276] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission. The string to encode.

[1277] HtmlEncode

[1278] [C#] public static void HtmlEncode(string s, TextWriter output); [C++] public: static void HtmlEncode(String* s, TextWriter* output); [VB] Public Shared Sub HtmlEncode(ByVal s As String, ByVal output As TextWriter) [JScript] public static function HtmlEncode(s: String, output: TextWriter);

Description

[1279] Converts a string into an HTML-encoded string, and returns the output as a TextWriter stream of output.

[1280] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. HTML encoding converts characters that are not allowed in HTML into character-entity equivalents; HTML decoding reverses the encoding. For example, when embedded in a block of text, the characters < and >, are encoded as < and > for HTTP transmission. The string to encode A System.IO.TextWriter output stream.

[1281] UrlDecode

[1282] [C#] public static string UrlDecode(string str); [C++] public: static String* UrlDecode(String* str); [VB] Public Shared Function UrlDecode(ByVal str As String) As String [JScript] public static function UrlDecode(str: String): String; Converts a string that has been encoded for transmission in a URL into a decoded string.

Description

[1283] Converts a string that has been encoded for transmission in a URL into a decoded string.

Return Value; The decoded string.

[1284] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The string to decode.

[1285] UrlDecode

[1286] [C#] public static string UrlDecode(byte[ ] bytes, Encoding e); [C++] public: static String* UrlDecode(unsigned char bytes _gc[ ], Encoding* e); [VB] Public Shared Function UrlDecode(ByVal bytes( ) As Byte, ByVal e As Encoding) As String [JScript] public static function UrlDecode(bytes: Byte[ ], e: Encoding): String;

Description

[1287] Converts a URL-encoded byte array into a decoded string, using the specified decoding method.

Return Value: The decoded string.

[1288] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The byte array to decode. The System.Text.Encoding that specifies the decoding method.

[1289] UrlDecode

[1290] [C#] public static string UrlDecode(string str, Encoding e); [C++] public: static String* UrlDecode(String* str, Encoding* e); [VB] Public Shared Function UrlDecode(ByVal str As String, ByVal e As Encoding) As String [JScript] public static function UrlDecode(str: String, e: Encoding): String;

Description

[1291] Converts a URL-encoded string into a decoded string, using the specified decoding method.

Return Value: The decoded string.

[1292] If characters such as blanks and punctuation are passed in an HTTP stream, 11 they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The string to decode. The System.Text.Encoding that specifies the decoding method.

[1293] UrlDecode

[1294] [C#] public static string UrlDecode(byte[ ] bytes, int offset, int count, Encoding e); [C++] public: static String* UrlDecode(unsigned char bytes _gc[ ], int offset, int count, Encoding* e); [VB] Public Shared Function UrlDecode(ByVal bytes( ) As Byte, ByVal offset As Integer, ByVal count As Integer, ByVal e As Encoding) As String [JScript] public static function UrlDecode(bytes: Byte[ ], offset: int, count: int, e: Encoding) String;

Description

[1295] Converts a URL-encoded byte array into a decoded string, using the specified decoding method, starting at the specified position in the array, and continuing for the specified number of bytes.

Return Value: The decoded string.

[1296] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to 11 be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The array of bytes to decode. The position in the byte to begin decoding. The number of bytes to decode starting at offset. The System.Text.Encoding object that specifies the decoding method.

[1297] UrlDecodeToBytes

[1298] [C#] public static byte[ ] UrlDecodeToBytes(byte[ ] bytes); [C++] public: static unsigned char UrlDecodeToBytes(unsigned char bytes _gc[ ]) _gc[ ]; [VB] Public Shared Function UrlDecodeToBytes(ByVal bytes( ) As Byte) As Byte( ) [JScript] public static function UrlDecodeToBytes(bytes: Byte[ ]): Byte[ ];

Description

[1299] Converts a URL-encoded arrray of bytes into a decoded array of bytes.

Return Value: The decoded array of bytes.

[1300] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The array of bytes to decode.

[1301] UrlDecodeToBytes

[1302] [C#] public static byte[ ] UrlDecodeToBytes(string str); [C++] public: static unsigned char UrlDecodeToBytes(String* str) _gc[ ]; [VB] Public Shared Function UrlDecodeToBytes(ByVal str As String) As Byte( ) [JScript] public static function UrlDecodeToBytes(str: String): Byte[ ]; Converts a URL-encoded string or byte array into a decoded array of bytes.

Description

[1303] Converts a URL-encoded string into a decoded array of bytes.

Return Value: The decoded array of bytes.

[1304] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The string to decode.

[1305] UrlDecodeToBytes

[1306] [C#] public static byte[ ] UrlDecodeToBytes(string str, Encoding e); [C++] public: static unsigned char UrlDecodeToBytes(String* str, Encoding* e) _gc[ ]; [VB] Public Shared Function UrlDecodeToBytes(ByVal str As String, ByVal e As Encoding) As Byte( ) [JScript] public static function UrlDecodeToBytes(str: String, e: Encoding): Byte[ ];

Description

[1307] Converts a URL-encoded string into a decoded array of bytes, using the specified decoding method.

Return Value. The decoded array of bytes.

[1308] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The string to decode. The System.Text.Encoding object that specifies the decoding method.

[1309] UrlDecodeToBytes

[1310] [C#] public static byte[ ] UrlDecodeToBytes(byte[ ] bytes, int offset, int count); [C++] public: static unsigned char UrlDecodeToBytes(unsigned char bytes _gc[ ], int offset, int count) _gc[ ]; [VB] Public Shared Function UrlDecodeToBytes(ByVal bytes( ) As Byte, ByVal offset As Integer, ByVal count As Integer) As Byte( ) [JScript] public static function UrlDecodeToBytes(bytes: Byte[ ], offset: int, count int) Byte[ ];

Description

[1311] Converts a URL-encoded arrray of bytes into a decoded array of bytes, starting at the specified position in the array and continuing for the specified number of bytes.

Return Value. The decoded array of bytes.

[1312] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The array of bytes to decode. The position in the byte array to begin decoding. The number of bytes to decode, starting at offset.

[1313] UrlEncode

[1314] [C#] public static string UrlEncode(byte[ ] bytes); [C++] public: static String* UrlEncode(unsigned char bytes _gc[ ]); [VB] Public Shared Function UrlEncode(ByVal bytes( ) As Byte) As String [JScript] public static function UrlEncode(bytes: Byte[ ]): String;

Description

[1315] Converts a byte array into an encoded URL string for reliable HTTP transmission from the Web server to a client.

Return Value. The encoded string.

[1316] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The byte array to encode.

[1317] UrlEncode

[1318] [C#] public static string UrlEncode(string str); [C++] public: static String* UrlEncode(String* str); [VB] Public Shared Function UrlEncode(ByVal str As String) As String [JScript] public static function UrlEncode(str: String): String; Encodes a URL string for reliable HTTP transmission from the Web server to a client.

Description

[1319] Encodes a URL string for reliable HTTP transmission from the Web server to a client.

Return Value. The encoded string.

[1320] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The text to encode.

[1321] UrlEncode

[1322] [C#] public static string UrlEncode(string str, Encoding e); [C++] public: static String* UrlEncode(String* str, Encoding* e); [VB] Public Shared Function UrlEncode(ByVal str As String, ByVal e As Encoding) As String [JScript] public static function UrlEncode(str: String, e: Encoding): String;

Description

[1323] Encodes a URL string for reliable HTTP transmission from the Web server to a client, using the specified encoding method.

Return Value. The encoded string.

[1324] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The text to encode. The System.Text.Encoding object that specifies the encoding scheme.

[1325] UrlEncode

[1326] [C#] public static string UrlEncode(byte[ ] bytes, int offset, int count); [C++] public: static String* UrlEncode(unsigned char bytes _gc[ ], int offset, int count); [VB] Public Shared Function UrlEncode(ByVal bytes( ) As Byte, ByVal offset As Integer, ByVal count As Integer) As String [JScript] public static function UrlEncode(bytes: Byte[ ], offset: int, count: int) String;

Description

[1327] Converts a byte array into a URL-encoded string for reliable HTTP transmission from the Web server to a client, starting at the specified position in the array and continuing for the specified number of bytes.

Return Value. The encoded string.

[1328] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The byte array to encode. The position in the byte array to begin encoding. The number of bytes to encode, starting at offset.

[1329] UrlEncodeToBytes

[1330] [C#] public static byte[ ] UrlEncodeToBytes(byte[ ] bytes); [C++] public: static unsigned char UrlEncodeToBytes(unsigned char bytes _gc[ ]) _gc[ ]; [VB] Public Shared Function UrlEncodeToBytes(ByVal bytes( ) As Byte) As Byte( ) [JScript] public static function UrlEncodeToBytes(bytes: Byte[ ]): Byte[ ];

Description

[1331] Converts an array of bytes into a URL-encoded array of bytes.

Return Value. The encoded array of bytes.

[1332] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The array of bytes to encode.

[1333] UrlEncodeToBytes

[1334] [C#] public static byte[ ] UrlEncodeToBytes(string str); [C++] public: static unsigned char UrlEncodeToBytes(String* str) _gc[ ]; [VB] Public Shared Function UrlEncodeToBytes(ByVal str As String) As Byte( ) [JScript] public static function UrlEncodeToBytes(str: String): Byte[ ]; Converts a string or a byte array into an encoded array of bytes for reliable HTTP transmission from the Web server to a client.

Description

[1335] Converts a string into a URL-encoded array of bytes Return Value. The encoded array of bytes.

[1336] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The string to encode.

[1337] UrlEncodeToBytes

[1338] [C#] public static byte[ ] UrlEncodeToBytes(string str, Encoding e); [C++] public: static unsigned char UrlEncodeToBytes(String* str, Encoding* e) _gc[ ]; [VB] Public Shared Function UrlEncodeToBytes(ByVal str As String, ByVal e As Encoding) As Byte( ) [JScript] public static function UrlEncodeToBytes(str: String, e: Encoding) Byte[ ];

Description

[1339] Converts a string into a URL-encoded array of bytes, using the specified encoding method.

Return Value. The encoded array of bytes.

[1340] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The string to encode The System.Text.Encoding that specifies the encoding method.

[1341] UrlEncodeToBytes

[1342] [C#] public static byte[ ] UrlEncodeToBytes(byte[ ] bytes, int offset, int count); [C++] public: static unsigned char UrlEncodeToBytes(unsigned char bytes _gc[ ], int offset, int count) _gc[ ]; [VB] Public Shared Function UrlEncodeToBytes(ByVal bytes( ) As Byte, ByVal offset As Integer, ByVal count As Integer) As Byte( ) [JScript] public static function UrlEncodeToBytes(bytes: Byte[ ], offset: int, count: int) Byte[ ];

Description

[1343] Converts an array of bytes into a URL-encoded array of bytes, starting at the specified position in the array and continuing for the specified number of bytes.

Return Value. The encoded array of bytes.

[1344] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The array of bytes to encode. The position in the byte array to begin encoding. The number of bytes to encode, starting at offset.

[1345] UrlEncodeUnicode

[1346] [C#] public static string UrlEncodeUnicode(string str); [C++] public: static String* UrlEncodeUnicode(String* str); [VB] Public Shared Function UrlEncodeUnicode(ByVal str As String) As String [JScript] public static function UrlEncodeUnicode(str: String): String;

Description

[1347] Converts a string into a Unicode string.

Return Value. The Unicode string.

[1348] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not legal in a URL to character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The string to convert.

[1349] UrlEncodeUnicodeToBytes

[1350] [C#] public static byte[ ] UrlEncodeUnicodeToBytes(string str); [C++] public: static unsigned char UrlEncodeUnicodeToBytes(String* str) _gc[ ]; [VB] Public Shared Function UrlEncodeUnicodeToBytes(ByVal str As String) As Byte( ) [JScript] public static function UrlEncodeUnicodeToBytes(str: String): Byte[ ];

Description

[1351] Converts a string into a Unicode array of bytes.

Return Value. The Unicode byte array.

[1352] If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not legal in a URL to character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as % 3c and % 3d. The string to convert.

[1353] HttpValidationStatus enumeration (System.Web)

[1354] UrlEncodeUnicodeToBytes

Description

[1355] Provides enumerated values that indicate cache validation status.

[1356] UrlEncodeUnicodeToBytes

[C#] public const HttpValidationStatus IgnoreThisRequest; [C++] public: const HttpValidationStatus IgnoreThisRequest; [VB] Public Const IgnoreThisRequest As HttpValidationStatus [JScript] public var IgnoreThisRequest: HttpValidationStatus;

Description

[1357] Specifies not to validate the entity in the cache.

[1358] UrlEncodeUnicodeToBytes

[C#] public const HttpValidationStatus Invalid; [C+] public: const HttpValidationStatus Invalid; [VB] Public Const Invalid As HttpValidationStatus [JScript] public var Invalid: HttpValidationStatus;

Description

[1359] Indicates that the cache is invalid.

[1360] UrlEncodeUnicodeToBytes

[C#] public const HttpValidationStatus Valid; [C++] public: const HttpValidationStatus Valid; [VB] Public Const Valid As HttpValidationStatus [JScript] public var Valid: HttpValidationStatus;

Description

[1361] Indicates that the cache is valid.

[1362] HttpWorkerRequest class (System.Web)

[1363] ToString

Description

[1364] This abstract class defines the base worker methods and enumerations used by ASP.NET managed code for request processing.

[1365] ToString

[C#] public const int HeaderAccept; [C++] public: const int HeaderAccept; [VB] Public Const HeaderAccept As Integer [JScript] public var HeaderAccept: int;

Description

[1366] ToString

[C#] public const int HeaderAcceptCharset; [C++] public: const int HeaderAcceptCharset; [VB] Public Const HeaderAcceptCharset As Integer [JScript] public var HeaderAcceptCharset: int;

Description

[1367] ToString

[C#] public const int HeaderAcceptEncoding; [C++] public: const int HeaderAcceptEncoding; [VB] Public Const HeaderAcceptEncoding As Integer [JScript] public var HeaderAcceptEncoding: int;

Description

[1368] ToString

[C#] public const int HeaderAcceptLanguage; [C++] public: const int HeaderAcceptLanguage; [VB] Public Const HeaderAcceptLanguage As Integer [JScript] public var HeaderAcceptLanguage: int;

Description

[1369] ToString

[C#] public const int HeaderAcceptRanges; [C++] public: const int HeaderAcceptRanges; [VB] Public Const HeaderAcceptRanges As Integer [JScript] public var HeaderAcceptRanges: int;

Description

[1370] ToString

[C#] public const int HeaderAge; ]C++] public: const int HeaderAge; [VB] Public Const HeaderAge As Integer [JScript] public var HeaderAge: int;

Description

[1371] ToString

[C#] public const int HeaderAllow; [C++] public: const int HeaderAllow; [VB] Public Const HeaderAllow As Integer [JScript] public var HeaderAllow: int;

Description

[1372] ToString

[C#] public const int HeaderAuthorization; [C++] public: const int HeaderAuthorization; [VB] Public Const HeaderAuthorization As Integer [JScript] public var HeaderAuthorization: int;

Description

[1373] ToString

[C#] public const int HeaderCacheControl; [C++] public: const int HeaderCacheControl; [VB] Public Const HeaderCacheControl As Integer [JScript] public var HeaderCacheControl: int;

Description

[1374] ToString

[C#] public const int HeaderConnection;

[1375] [C++] public: const int HeaderConnection; [VB] Public Const HeaderConnection As Integer [JScript] public var HeaderConnection: int;

Description

[1376] ToString

[C#] public const int HeaderContentEncoding; [C++] public: const int HeaderContentEncoding; [VB] Public Const HeaderContentEncoding As Integer [JScript] public var HeaderContentEncoding: int;

Description

[1377] ToString

[C#] public const int HeaderContentLanguage; [C++] public: const int HeaderContentLanguage; [VB] Public Const HeaderContentLanguage As Integer [JScript] public var HeaderContentLanguage: int;

Description

[1378] ToString

[C#] public const int HeaderContentLength; [C++] public: const int HeaderContentLength; [VB] Public Const HeaderContentLength As Integer [JScript] public var HeaderContentLength: int;

Description

[1379] ToString

[C#] public const int HeaderContentLocation; [C++] public: const int HeaderContentLocation; [VB] Public Const HeaderContentLocation As Integer [JScript] public var HeaderContentLocation: int;

Description

[1380] ToString

[C#] public const int HeaderContentMd5; [C++] public: const int HeaderContentMd5; [VB] Public Const HeaderContentMd5 As Integer [JScript] public var HeaderContentMd5: int;

Description

[1381] ToString

[C#] public const int HeaderContentRange; [C++] public: const int HeaderContentRange; [VB] Public Const HeaderContentRange As Integer [JScript] public var HeaderContentRange: int;

Description

[1382] ToString

[C#] public const int HeaderContentType; [C++] public: const int HeaderContentType; [VB] Public Const HeaderContentType As Integer [JScript] public var HeaderContentType: int;

Description

[1383] ToString

[C#] public const int HeaderCookie; [C++] public: const int HeaderCookie; [VB] Public Const HeaderCookie As Integer [JScript] public var HeaderCookie: int;

Description

[1384] ToString

[C#] public const int HeaderDate; [C++] public: const int HeaderDate; [VB] Public Const HeaderDate As Integer [JScript] public var HeaderDate int;

Description

[1385] ToString

[C#] public const int HeaderEtag; [C++] public: const int HeaderEtag; [VB] Public Const HeaderEtag As Integer [JScript] public var HeaderEtag: int;

Description

[1386] ToString

[C#] public const int HeaderExpect; [C++] public: const int HeaderExpect; [VB] Public Const HeaderExpect As Integer [JScript] public var HeaderExpect: int;

Description

[1387] ToString

[C#] public const int HeaderExpires; [C++] public: const int HeaderExpires; [VB] Public Const HeaderExpires As Integer [JScript] public var HeaderExpires: int;

Description

[1388] ToString

[C#] public const int HeaderFrom; [C++#] public: const int HeaderFrom; [VB] Public Const HeaderFrom As Integer [JScript] public var HeaderFrom: int;

Description

[1389] ToString

[C#] public const int HeaderHost; [C++] public: const int HeaderHost; [VB] Public Const HeaderHost As Integer [JScript] public var HeaderHost: int;

Description

[1390] ToString

[C#] public const int HeaderIfMatch; [C++] public: const int HeaderIFMatch; [VB] Public Const HeaderIMatch As Integer [JScript] public var HeaderIfMatch: int;

Description

[1391] ToString

[C#] public const int HeaderIfModifiedSince; [C++] public: const int HeaderIfModifiedSince; [VB] Public Const HeaderIfModifiedSince As Integer [JScript] public var HeaderIfModifiedSince: int;

Description

[1392] ToString

[C#] public const int HeaderIfNoneMatch; [C++] public: const int HeaderIfNoneMatch; [VB] Public Const HeaderIfNoneMatch As Integer [JScript] public var HeaderIfNoneMatch: int;

Description

[1393] ToString

[C#] public const int HeaderIfRange; [C++] public: const int HeaderIfRange; [VB] Public Const HeaderIfRange As Integer [JScript] public var HeaderIfRange: int;

Description

[1394] ToString

[C#] public const int HeaderIfUnmodifiedSince; [C+°] public: const int HeaderIfUnmodifiedSince; [VB] Public Const HeaderIfUnmodifiedSince As Integer [JScript] public var HeaderIfUnmodifiedSince: int;

Description

[1395] ToString

[C#] public const int HeaderKeepAlive; [C++] public: const int HeaderKeepAlive; [VB] Public Const HeaderKeepAlive As Integer [JScript] public var HeaderKeepAlive: int;

Description

[1396] ToString

[C#] public const int HeaderLastModified; [C++] public: const int HeaderLastModified; [VB] Public Const HeaderLastModified As Integer [JScript] public var HeaderLastModified: int;

Description

[1397] ToString

[C#] public const int HeaderLocation; [C++] public: const int HeaderLocation; [VB] Public Const HeaderLocation As Integer [JScript] public var HeaderLocation: int;

Description

[1398] ToString

[C#] public const int HeaderMaxForwards; [C++] public: const int HeaderMaxForwards; [VB] Public Const HeaderMaxForwards As Integer [JScript] public var HeaderMaxForwards: int;

Description

[1399] ToString

[C#] public const int HeaderPragma; [C++] public: const int HeaderPragma; [VB] Public Const HeaderPragma As Integer [JScript] public var HeaderPragma: int;

Description

[1400] ToString

[C#] public const int HeaderProxyAuthenticate; [C++] public: const int HeaderProxyAuthenticate; [VB] Public Const HeaderProxyAuthenticate As Integer [JScript] public var HeaderProxyAuthenticate: int;

Description

[1401] ToString

[C#] public const int HeaderProxyAuthorization; [C++] public: const int HeaderProxyAuthorization; [VB] Public Const HeaderProxyAuthorization As Integer [JScript] public var HeaderProxyAuthorization: int;

Description

[1402] ToString

• [1403] [C#] public const int HeaderRange; [C++] public: const int HeaderRange; [VB] Public Const HeaderRange As Integer [JScript] public var HeaderRange: int;
  Description

[1404] ToString

[1405] [C#] public const int HeaderReferer; [C++] public: const int HeaderReferer; [VB] Public Const HeaderReferer As Integer [JScript] public var HeaderReferer: int;

Description

[1406] ToString

[C#] public const int HeaderRetryAfter; [C++] public: const int HeaderRetryAfter; [VB] Public Const HeaderRetryAfter As Integer [JScript] public var HeaderRetryAfter: int;

Description

[1407] ToString

[C#] public const int HeaderServer; [C++] public: const int HeaderServer; [VB] Public Const HeaderServer As Integer [JScript] public var HeaderServer: int;

Description

[1408] ToString

[C#] public const int HeaderSetCookie; [C++] public: const int HeaderSetCookie; [VB] Public Const HeaderSetCookie As Integer [JScript] public var HeaderSetCookie: int;

Description

[1409] ToString

[C#] public const int HeaderTe; [C++] public: const int HeaderTe; [VB] Public Const HeaderTe As Integer [JScript] public var HeaderTe int;

Description

[1410] ToString

[C#] public const int HeaderTrailer; [C++] public: const Int HeaderTrailer; [VB] Public Const HeaderTrailer As Integer [JScript] public var HeaderTrailer: int;

Description

[1411] ToString

[C#] public const int HeaderTransferEncoding; [C++] public: const int HeaderTransferEncoding; [VB] Public Const HeaderTransferEncoding As Integer [JScript] public var HeaderTransferEncoding: int;

Description

[1412] ToString

[C#] public const int HeaderUpgrade; [C++] public: const int HeaderUpgrade; [VB] Public Const HeaderUpgrade As Integer [JScript] public var HeaderUpgrade: int;

Description

[1413] ToString

[C#] public const int HeaderUserAgent; [C++] public: const int HeaderUserAgent; [VB] Public Const HeaderUserAgent As Integer [JScript] public var HeaderUserAgent: int;

Description

[1414] ToString

[C#] public const int HeaderVary; [C++] public: const int HeaderVary; [VB] Public Const HeaderVary As Integer [JScript] public var HeaderVary: int;

Description

[1415] ToString

[C#] public const int HeaderVia; [C++] public: const int HeaderVia; [VB] Public Const HeaderVia As Integer [JScript] public var HeaderVia: int;

Description

[1416] ToString

[C#] public const int HeaderWarning; [C++] public: const int HeaderWarning; [VB] Public Const HeaderWarning As Integer [JScript] public var HeaderWarning: int;

Description

[1417] ToString

[C#] public const int HeaderWwwAuthenticate; [C++] public: const int HeaderWwwAuthenticate; [VB] Public Const HeaderWwwAuthenticate As Integer [JScript] public var HeaderWwwAuthenticate: int;

Description

[1418] ToString

[C#] public const int ReasonCachePolicy; [C++] public: const int ReasonCachePolicy; [VB] Public Const ReasonCachePolicy As Integer [JScript] public var ReasonCachePolicy: int;

Description

[1419] ToString

[C#] public const int ReasonCacheSecurity; [C++] public: const int ReasonCacheSecurity; [VB] Public Const ReasonCacheSecurity As Integer [JScript] public var ReasonCacheSecurity: int;

Description

[1420] ToString

[C#] public const int ReasonClientDisconnect; [C++9 public: const it ReasonClientDisconnect; [VB] Public Const ReasonClientDisconnect As Integer [JScript] public var ReasonClientDisconnect: int;

Description

[1421] ToString

[C#] public const int ReasonDefault; [C++] public: const int ReasonDefault; [VB] Public Const ReasonDefault As Integer [JScript] public var ReasonDefault: int;

Description

[1422] ToString

[C#] public const int ReasonFileHandleCacheMiss; [C++] public: const int ReasonFileHandleCacheMiss; [VB] Public Const ReasonFileHandleCacheMiss As Integer [JScript] public var ReasonFileHandleCacheMiss: int;

Description

[1423] ToString

[C#] public const int ReasonResponseCacheMiss; [C++] public: const int ReasonResponseCacheMiss; [VB] Public Const ReasonResponseCacheMiss As Integer [JScript] public var ReasonResponseCacheMiss: int;

Description

[1424] ToString

[C#] public const int RequestHeaderMaximum; [C++] public: const int RequestHeaderMaximum; [VB] Public Const RequestHeaderMaximum As Integer [JScript] public var RequestHeaderMaximum: int;

Description

[1425] ToString

[C#] public const int ResponseHeaderMaximum; [C++] public: const int ResponseHeaderMaximum; [VB] Public Const ResponseHeaderMaximum As Integer [JScript] public var ResponseHeaderMaximum: int;

Description

[1426] HttpWorkerRequest

[1427] Example Syntax:

[1428] ToString

[C#] protected HttpWorkerRequest( ); [C++] protected: HttpWorkerRequest( ); [VB] Protected Sub New( ) [JScript] protected function HttpWorkerRequest( );

[1429] MachineConfigPath

[1430] ToString

[C#] public virtual string MachineConfigPath {get;} [C++] public: property virtual String* get MachineConfigPath( ); [VB] Overridable Public ReadOnly Property MachineConfigPath As String [JScript] public function get MachineConfigPath( ): String;

Description

[1431] MachineInstalIDirectory

[1432] ToString

[1433] [C#] public virtual string MachineInstalIDirectory {get;} [C++] public: property virtual String* get MachineInstalIDirectory( ); [VB] Overridable Public ReadOnly Property MachineInstalIDirectory As String [JScript] public function get MachineInstalIDirectory( ): String;

Description

[1434] CloseConnection

[C#] public virtual void CloseConnection( ); [C++] public: virtual void CloseConnection( ); [VB] Overridable Public Sub CloseConnection( ) [JScript] public function CloseConnection( );

Description

[1435] EndOfRequest

[C#] public abstract void EndOfRequest( ); [C++] public: virtual void EndOfRequest( )=0; [VB] MustOverride Public Sub EndOfRequest( ) [JScript] public abstract function EndOfRequest( );

Description

[1436] FlushResponse

[1437] [C#] public abstract void FlushResponse(bool finalFlush); [C++] public: virtual void FlushResponse(bool finalFlush)=0; [VB] MustOverride Public Sub FlushResponse(ByVal finalFlush As Boolean) [JScript] public abstract function FlushResponse(finalFlush: Boolean);

Description

[1438] GetAppPath

[C#] public virtual string GetAppPath( ); [C++] public: virtual String* GetAppPath( ); [VB] Overridable Public Function GetAppPath( ) As String [JScript] public function GetAppPath( ): String;

Description

[1439] When overridden in a derived class, returns the virtual path to the currently executing server application.

Return Value. The virtual path of the current application.

[1440] GetAppPathTranslated

[C#] public virtual string GetAppPathTranslated( ); [C++] public: virtual String* GetAppPathTranslated( ); [VB] Overridable Public Function GetAppPathTranslated( ) As String [JScript] public function GetAppPathTranslated( ): String;

Description

[1441] When overridden in a derived class, returns the UNC-translated path to the currently executing server application.

Return Value. The UNC physical path of the current application.

[1442] GetAppPoolID

[C#] public virtual string GetAppPoolID( ); [C++] public: virtual String* GetAppPoolID( ); [VB] Overridable Public Function GetAppPoolID( ) As String [JScript] public function GetAppPoolID( ): String;

Description

[1443] When overridden in a derived class, returns the application pool ID for the current URL.

Return Value. Always returns null.

[1444] GetBytesRead

[C#] public virtual long GetBytesRead( ); [C++] public: virtual _int64 GetBytesRead( ); [VB] Overridable Public Function GetBytesRead( ) As Long [JScript] public function GetBytesRead( ): long;

Description

[1445] GetClientCertificate

[C#] public virtual byte[ ] GetClientCertificate( ); [C++] public: virtual unsigned char GetClientCertificate( ) _gc[ ]; [VB] Overridable Public Function GetClientCertificate( ) As Byte( ) [JScript] public function GetClientCertificate( ): Byte[ ];

Description

[1446] Defines the base worker class used by ASP.NET managed code for request processing.

[1447]

[1448] GetClientCertificateBinaryIssuer

[1449] [C#] public virtual byte[ ] GetClientCertificateBinaryIssuer( ); [C++] public: virtual unsigned char GetClientCertificateBinaryIssuer( ) _gc[ ]; [VB] Overridable Public Function GetClientCertificateBinaryIssuer( ) As Byte( ) [JScript] public function GetClientCertificateBinaryIssuer( ): Byte[ ];

Description

[1450] GetClientCertificateEncoding

[1451] [C#] public virtual int GetClientCertificateEncoding( ); [C++] public: virtual int GetClientCertificateEncoding( ); [VB] Overridable Public Function GetClientCertificateEncoding( ) As Integer [JScript] public function GetClientCertificateEncoding( ): int;

Description

[1452] GetClientCertificatePublicKey

[1453] [C#] public virtual byte[ ] GetClientCertificatePublicKey( ); [C++] public: virtual unsigned char GetClientCertificatePublicKey( ) _gc[ ]; [VB] Overridable Public Function GetClientCertificatePublicKey( ) As Byte( ) [JScript] public function GetClientCertificatePublicKey( ): Byte[ ];

Description

[1454] GetClientCertificateValidFrom

[1455] [C#] public virtual DateTime GetClientCertificateValidFrom( ); [C++] Public: virtual DateTime GetClientCertificateValidFrom( ); [VB] Overridable Public Function GetClientCertificateValidFrom( ) As DateTime [JScript] public function GetClientCertificateValidFrom( ): DateTime;

Description

[1456] GetClientCertificateValidUntil

[1457] [C#] public virtual DateTime GetClientCertificateValidUntil( ); [C++] public: virtual DateTime GetClientCertificateValidUntil( ); [VB] Overridable Public Function GetClientCertificateValidUntil( ) As DateTime [JScript] public function GetClientCertificateValidUntil( ): DateTime;

Description

GetConnectionID

[C#] public virtual long GetConnectionID( ); [C++] public: virtual _int64 GetConnectionID( ); [VB] Overridable Public Function GetConnectionID( ) As Long [JScript] public function GetConnectionID( ): long;

Description

[1458] When overridden in a derived class, returns the ID of the current connection.

Return Value. Always returns 0.

[1459] GetFilePath

[C#] public virtual string GetFilePath( ); [C++] public: virtual String* GetFilePath( ); [VB] Overridable Public Function GetFilePath( ) As String [JScript] public function GetFilePath( ): String;

Description

[1460] When overridden in a derived class, returns the physical path to the requested URI.

Return Value. The path to the URI.

[1461] GetFilePathTranslated

[C#] public virtual string GetFilePathTranslated( ); [C++] public: virtual String* GetFilePathTranslated( ); [VB] Overridable Public Function GetFilePathTranslated( ) As String [JScript] public function GetFilePathTranslated( ): String;

Description

[1462] When overridden in a derived class, returns the translated file path to the requested URI (from virtual path to UNC path, ie “/proj1/page.aspx” to “c:\dir\page.aspx”)

Return Value. The translated file path.

[1463] GetHttpVerbName

[C#] public abstract string GetHttpVerbName( ); [C++] public: virtual String* GetHttpVerbName( )=0; [VB] MustOverride Public Function GetHttpVerbName( ) As String [JScript] public abstract function GetHttpVerbName( ): String;

Description

[1464] Provides access to the specified member of the request header.

Return Value. The HTTP verb returned in the request header.

[1465] GetHttpVersion

[C#] public abstract string GetHttpVersion( ); [C++] public: virtual String* GetHttpVersion( )=0; [VB] MustOverride Public Function GetHttpVersion( ) As String [JScript] public abstract function GetHttpVersion( ): String;

Description

[1466] Provides access to the specified member of the request header.

Return Value. The HTTP version returned in the request header.

[1467] GetKnownRequestHeader

[1468] [C#] public virtual string GetKnownRequestHeader(int index); [C++] public: virtual String* GetKnownRequestHeader(int index); [VB] Overridable Public Function GetKnownRequestHeader(ByVal index As Integer) As String [JScript] public function GetKnownRequestHeader(index: int): String;

Description

[1469] GetKnownRequestHeaderIndex

[1470] [C#] public static int GetKnownRequestHeaderIndex(string header); [C++] public: static int GetKnownRequestHeaderIndex(String* header); [VB] Public Shared Function GetKnownRequestHeaderIndex(ByVal header As String) As Integer [JScript] public static function GetKnownRequestHeaderIndex(header: String) int;

Description

[1471] GetKnownRequestHeaderName

[1472] [C#] public static string GetKnownRequestHeaderName(int index); [C++] public: static String* GetKnownRequestHeaderName(int index); [VB] Public Shared Function GetKnownRequestHeaderName(ByVal index As Integer) As String [JScript] public static function GetKnownRequestHeaderName(index: int) String;

Description

[1473] GetKnownResponseHeaderIndex

[1474] [C#] public static int GetKnownResponseHeaderIndex(string header); [C++] public: static int GetKnownResponseHeaderIndex(String* header); [VB] Public Shared Function GetKnownResponseHeaderIndex(ByVal header As String) As Integer [JScript] public static function GetKnownResponseHeaderIndex(header: String) int;

Description

[1475] GetKnownResponseHeaderName

[1476] [C#] public static string GetKnownResponseHeaderName(int index); [C++] public: static String* GetKnownResponseHeaderName(int index); [VB] Public Shared Function GetKnownResponseHeaderName(ByVal index As Integer) As String [JScript] public static function GetKnownResponseHeaderName(index: int) String;

Description

[1477] GetLocalAddress

[C#] public abstract string GetLocalAddress( ); [C++] public: virtual String* GetLocalAddress( )=0; [VB] MustOverride Public Function GetLocalAddress( ) As String [JScript] public abstract function GetLocalAddress( ): String;

Description

[1478] Provides access to the specified member of the request header.

Return Value. The server's IP address returned in the request header.

[1479] GetLocalPort

[C#] public abstract int GetLocalPort( ); [C++] public: virtual int GetLocalPort( )=0; [VB] MustOverride Public Function GetLocalPort( ) As Integer [JScript] public abstract function GetLocalPort( ): int;

Description

[1480] Provides access to the specified member of the request header.

Return Value. The server's port number returned in the request header.

[1481] GetPathInfo

[C#] public virtual string GetPathInfo( ); [C++]public: virtual String* GetPathInfo( ); [VB] Overridable Public Function GetPathInfo( ) As String [JScript] public function GetPathInfo( ): String;

Description

[1482] When overridden in a derived class, returns additional path information for a resource with a URL extension. That is, for the URL /virdir/page.html/tail, the PathInfo value is /tail.

Return Value. Additional path information for a resource.

[1483] GetPreloadedEntityBody

[1484] [C#] public virtual byte[ ] GetPreloadedEntityBody( ); [C++] public: virtual unsigned char GetPreloadedEntityBody( ) _gc[ ]; [VB] Overridable Public Function GetPreloadedEntityBody( ) As Byte( ) [JScript] public function GetPreloadedEntityBody( ): Byte[ ];

Description

[1485] GetProtocol

[C#] public virtual string GetProtocol( ); [C++] public: virtual String* GetProtocol( ); [VB] Overridable Public Function GetProtocol( ) As String [JScript] public function GetProtocol( ): String;

Description

[1486] When overridden in a derived class, returns the HTTP protocol (HTTP or HTTPS).

Return Value. HTTPS if IsSecure is true, otherwise false.

[1487] GetQueryString [C#] public abstract string GetQueryString( ); [C++] public: virtual String* GetQueryString( )=0; [VB] MustOverride Public Function GetQueryString( ) As String [JScript] public abstract function GetQueryString( ): String;

Description

[1488] Provides access to the specified member of the request header.

Return Value. The QueryString member of the request header.

[1489] GetQueryStringRawBytes

[1490] [C#] public virtual byte[ ] GetQueryStringRawBytes( ); [C++] public: virtual unsigned char GetQueryStringRawBytes( ) _gc[ ]; [VB] Overridable Public Function GetQueryStringRawBytes( ) As Byte( ) [JScript] public function GetQueryStringRawBytes( ): Byte[ ];

Description

[1491] When overridden in a derived class, returns the response query string as an array of bytes.

Return Value. An array of bytes containing the response.

[1492] GetRawUrl

[C#] public abstract string GetRawUrl( ); [C++] public: virtual String* GetRawUrl( )=0; [VB] MustOverride Public Function GetRawUrl( ) As String [JScript] public abstract function GetRawUrl( ): String;

Description

[1493] Provides access to the specified member of the request header.

Return Value. The raw url member of the request header.

[1494] GetRemoteAddress

[C#] public abstract string GetRemoteAddress( ); [C++] public: virtual String* GetRemoteAddress( )=0; [VB] MustOverride Public Function GetRemoteAddress( ) As String [JScript] public abstract function GetRemoteAddress( ): String;

Description

[1495] Provides access to the specified member of the request header.

Return Value: The client's IP address returned in the request header.

[1496] GetRemoteName

[C#] public virtual string GetRemoteName( ); [C++] public: virtual String* GetRemoteName( ); [VB] Overridable Public Function GetRemoteName( ) As String [JScript] public function GetRemoteName( ): String;

Description

[1497] When overridden in a derived class, returns the client computer's name.

Return Value. The name of the client machine.

[1498] GetRemotePort

[C#] public abstract int GetRemotePort( ); [C++] public: virtual int GetRemotePort( )=0; [VB] MustOverride Public Function GetRemotePort( ) As Integer [JScript] public abstract function GetRemotePort( ): int;

Description

[1499] Provides access to the specified member of the request header.

Return Value. The client HTTP port number returned in the request header.

[1500] GetRequestReason

[C#] public virtual int GetRequestReason( ); [C++]public: virtual int GetRequestReason( ); [VB] Overridable Public Function GetRequestReason( ) As Integer [JScript] public function GetRequestReason( ): int;

Description

[1501] When overridden in a derived class, returns the reason for the request. Return Value. Reason code. The default is ReasonResponseCacheMiss.

[1502] GetServerName

[C#] public virtual string GetServerName( ); [C++]public: virtual String* GetServerName( ); [VB] Overridable Public Function GetServerName( ) As String [JScript] public function GetServerName( ): String;

Description

[1503] When overridden in a derived class, returns the name of the local server.

Return Value. The name of the server.

[1504] GetServerVariable

[1505] [C#] public virtual string GetServerVariable(string name); [C++] public: virtual String* GetServerVariable(String* name); [VB] Overridable Public Function GetServerVariable(ByVal name As String) As String [JScript] public function GetServerVariable(name: String): String;

Description

[1506] GetStatusDescription

[1507] [C#] public static string GetStatusDescription(int code); [C++] public: static String* GetStatusDescription(int code); [VB] Public Shared Function GetStatusDescription(ByVal code As Integer) As String [JScript] public static function GetStatusDescription(code: int): String;

Description

[1508] GetUnknownRequestHeader

[1509] [C#] public virtual string GetUnknownRequestHeader(string name); [C++] public: virtual String* GetUnknownRequestHeader(String* name); [VB] Overridable Public Function GetUnknownRequestHeader(ByVal name As String) As String [JScript] public function GetUnknownRequestHeader(name: String): String;

Description

[1510] GetUnknownRequestHeaders

[1511] [C#] public virtual string[ ] [ ] GetUnknownRequestHeaders( ) ; [C++] public: virtual String* GetUnknownRequestHeaders( ) []] [VB] Overridable Public Function GetUnknownRequestHeaders( ) As String( ) ( ) [JScript] public function GetUnknownRequestHeaders( ): String[ ] [ ];

Description

[1512] GetUriPath

[C#] public abstract string GetUriPath( ); [C++] public: virtual String* GetUriPath( )=0; [VB] MustOverride Public Function GetUriPath( ) As String [JScript] public abstract function GetUriPath( ): String;

Description

[1513] Returns the physical path to the requested URI.

Return Value. The path of the requested URI.

[1514] GetUrlContextID

[C#] public virtual long GetUrlContextID( ); [C++] public: virtual _int64 GetUrlContextID( ); [VB] Overridable Public Function GetUrlContextID( ) As Long [JScript] public function GetUrlContextID( ): long;

Description

[1515] When overridden in a derived class, returns the context ID of the current connection.

Return Value. Always returns 0.

[1516] GetUserToken

[C#] public virtual IntPtr GetUserToken( ); [C++] public: virtual IntPtr GetUserToken( ); [VB] Overridable Public Function GetUserToken( ) As IntPtr [JScript] public function GetUserToken( ): IntPtr;

Description

[1517] When overridden in a derived class, returns the client's impersonation token.

Return Value. The value representing the impersonation token. The default is 0.

[1518] GetVirtualPathToken

[C#] public virtual IntPtr GetVirtualPathToken( ); [C++] public: virtual IntPtr GetVirtualPathToken( ); [VB] Overridable Public Function GetVirtualPathToken( ) As IntPtr [JScript] public function GetVirtualPathToken( ): IntPtr;

Description

[1519] HasEntityBody

[C#] public bool HasEntityBody( ); [C++] public: bool HasEntityBody( ); [VB] Public Function HasEntityBody( ) As Boolean [JScript] public function HasEntityBody( ): Boolean;

Description

[1520] HeadersSent

[C#] public virtual bool HeadersSent( ); [C++] public: virtual bool HeadersSent( ); [VB] Overridable Public Function HeadersSent( ) As Boolean [JScript] public function HeadersSent( ): Boolean;

Description

[1521] IsClientConnected

[C#] public virtual bool IsClientConnected( ); [C++] public: virtual bool IsClientConnected( ); [VB] Overridable Public Function IsClientConnected( ) As Boolean [JScript] public function IsClientConnected( ): Boolean;

Description

[1522] IsEntireEntityBodyIsPreloaded

[1523] [C#] public virtual bool IsEntireEntityBodyIsPreloaded( ); [C++] public: virtual bool IsEntireEntityBodyIsPreloaded( ); [VB] Overridable Public Function IsEntireEntityBodyIsPreloaded( ) As Boolean [JScript] public function IsEntireEntityBodyIsPreloaded( ): Boolean;

Description

[1524] IsSecure

[C#] public virtual bool IsSecure( ); [C++] public: virtual bool IsSecure( ); [VB] Overridable Public Function IsSecure( ) As Boolean [JScript] public function IsSecure( ): Boolean;

Description

[1525] When overridden in a derived class, returns a value indicating whether the connection is secure (using SSL).

Return Value: true if the connection is secure, otherwise false. The default is false.

[1526] MapPath

[1527] [C#] public virtual string MapPath(string virtualPath); [C++] public: virtual String* MapPath(String* virtualPath); [VB] Overridable Public Function MapPath(ByVal virtualPath As String) As String [JScript] public function MapPath(virtualPath: String): String;

Description

[1528] ReadEntityBody

[1529] [C#] public virtual int ReadEntityBody(byte[ ] buffer, int size); [C++] public: virtual int ReadEntityBody(unsigned char buffer _gc[ ], int size); [VB] Overridable Public Function ReadEntityBody(ByVal buffer( ) As Byte, ByVal size As Integer) As Integer [JScript] public function ReadEntityBody(buffer: Byte[ ], size: int): int;

Description

[1530] SendCalculatedContentLength

[1531] [C#] public virtual void SendCalculatedContentLength(int contentLength); [C++] public: virtual void SendCalculatedContentLength(int contentLength); [VB] Overridable Public Sub SendCalculatedContentLength(ByVal contentLength As Integer) [JScript] public function SendCalculatedContentLength(contentLength: int);

Description

[1532] SendKnownResponseHeader

[1533] [C#] public abstract void SendKnownResponseHeader(int index, string value); [C++] public: virtual void SendKnownResponseHeader(int index, String* value)=0; [VB] MustOverride Public Sub SendKnownResponseHeader(ByVal index As Integer, ByVal value As String) [JScript] public abstract function SendKnownResponseHeader(index: int, value String);

Description

[1534] SendResponseFromFile

[1535] [C#] public abstract void SendResponseFromFile(IntPtr handle, long offset, long length); [C++] public: virtual void SendResponseFromFile(IntPtr handle, _int64 offset, _int64 length)=0; [VB] MustOverride Public Sub SendResponseFromFile(ByVal handle As IntPtr, ByVal offset As Long, ByVal length As Long) [JScript] public abstract function SendResponseFromFile(handle: IntPtr, offset: long, length: long);

Description

[1536] SendResponseFromFile

[1537] [C#] public abstract void SendResponseFromFile(string filename, long offset, long length); [C++] public: virtual void SendResponseFromFile(String* filename, _int64 offset, _int64 length)=0; [VB] MustOverride Public Sub SendResponseFromFile(ByVal filename As String, ByVal offset As Long, ByVal length As Long) [JScript] public abstract function SendResponseFromFile(filename: String, offset: long, length: long);

Description

[1538] SendResponseFromMemory

[1539] [C#] public abstract void SendResponseFromMemory(byte[ ] data, int length); [C++] public: virtual void SendResponseFromMemory(unsigned char data _gc[ ], int length)=0; [VB] MustOverride Public Sub SendResponseFromMemory(ByVal data( ) As Byte, ByVal length As Integer) [JScript] public abstract function SendResponseFromMemory(data: Byte[ ], length int);

Description

[1540] SendResponseFromMemory

[1541] [C#] public virtual void SendResponseFromMemory(IntPtr data, int length); [C++] public: virtual void SendResponseFromMemory(IntPtr data, int length); [VB] Overridable Public Sub SendResponseFromMemory(ByVal data As IntPtr, ByVal length As Integer) [JScript] public function SendResponseFromMemory(data: IntPtr, length: int);

Description

[1542] SendStatus

[1543] [C#] public abstract void SendStatus(int statusCode, string statusDescription); [C++] public: virtual void SendStatus(int statusCode, String* statusDescription)=0; [VB] MustOverride Public Sub SendStatus(ByVal statusCode As Integer, ByVal statusDescription As String) [JScript] public abstract function SendStatus(statusCode: int, statusDescription String);

Description

[1544] SendUnknownResponseHeader

[1545] [C#] public abstract void SendUnknownResponseHeader(string name, string value); [C++] public: virtual void SendUnknownResponseHeader(String* name, String* value) 0; [VB] MustOverride Public Sub SendUnknownResponseHeader(ByVal name As String, ByVal value As String) [JScript] public abstract function SendUnknownResponseHeader(name: String, value String);

Description

[1546] SetEndOfSendNotification

[1547] [C#] public virtual void SetEndOfSendNotification(HttpWorkerRequest.EndOfSendNotification callback, object extraData); [C++] public: virtual void SetEndOfSendNotification(HttpWorkerRequest.EndOfSendNotification* callback, Object* extraData); [VB] Overridable Public Sub SetEndOfSendNotification(ByVal callback As HttpWorkerRequest.EndOfSendNotification, ByVal extraData As Object) [JScript] public function SetEndOfSendNotification(callback HttpWorkerRequest.EndOfSendNotification, extraData: Object);

Description

[1548] HttpWriter class (System.Web)

[1549] ToString

Description

[1550] Provides a System.IO.TextWriter object that is accessed through the intrinsic System.Web.HttpResponse object.

[1551] The System.Web.HttpResponse.Write(System.String) methods of the intrinsic System.Web.HttpResponse object make internal calls to an HttpWriter object.

[1552] Encoding

[1553] ToString

Description

[1554] Gets an System.Text.Encoding object for the System.IO.TextWriter.

[1555] FormatProvider

[1556] NewLine

[1557] OutputStream

[1558] ToString

Description

[1559] Gets a System.IO.Stream object to enable HTTP output directly from the Stream

[1560] Close

[C#] public override void Close( ); [C++] public: void Close( ); [VB] Overrides Public Sub Close( ) [JScript] public override function Close( ) ;

Description

[1561] Sends all buffered output to the HTTP output stream and closes the socket connection.

[1562] Flush

[C#] public override void Flush( ); [C++] public: void Flush( ); [VB] Overrides Public Sub Flush( ) [JScript] public override function Flush( );

Description

[1563] Sends all buffered output to the HTTP output stream.

[1564] Write

[C#] public override void Write(char ch); [C++] public: void Write(_wchar_t ch); [VB] Overrides Public Sub Write(ByVal ch As Char) [JScript] public override function Write(ch: Char); Sends HTTP output to the client.

Description

[1565] Sends a single character to the HTTP output stream. The character to send to the HTTP output stream.

[1566] Write

[C#] public override void Write(object obj); [C++] public: void Write(Object* obj); [VB] Overrides Public Sub Write(ByVal obj As Object) [JScript] public override function Write(obj: Object);

Description

[1567] Sends an Object to the HTTP output stream. The Object to send to the HTTP output stream.

[1568] Write

[C#] public override void Write(string s); [C++] public: void Write(String* s); [VB] Overrides Public Sub Write(ByVal s As String) [JScript] public override function Write(s: String);

Description

[1569] Sends a string to the HTTP output stream. The string to send to the HTTP output stream.

[1570] Write

[1571] [C#] public override void Write(char[ ] buffer, int index, int count); [C++] public: void Write(_wchar_t buffer _gc[ ], int index, int count); [VB] Overrides Public Sub Write(ByVal buffer( ) As Char, ByVal index As Integer, ByVal count As Integer) [JScript] public override function Write(buffer: Char[ ], index: int, count: int);

Description

[1572] Sends a stream of characters with the specified starting position and number of characters to the HTTP output stream. The memory buffer containing the characters to send to the HTTP output stream The buffer position of the first character to send. The number of characters to send beginning at the position specified by index.

[1573] WriteBytes

[1574] [C#] public void WriteBytes(byte[ ] buffer, int index, int count); [C++] public: void WriteBytes(unsigned char buffer _gc[ ], int index, int count); [VB] Public Sub WriteBytes(ByVal buffer( ) As Byte, ByVal index As Integer, ByVal count As Integer) [JScript] public function WriteBytes(buffer: Byte[ ], index: int, count: int);

Description

[1575] Sends a stream of bytes with the specified starting position and number of bytes to the HTTP output stream. The memory buffer containing the bytes to send to the HTTP output stream. The buffer position of the first byte to send. The number of bytes to send, beginning at the byte position specified by index.

[1576] WriteLine

[C#] public override void WriteLine( ); [C++] public: void WriteLine( ); [VB] Overrides Public Sub WriteLine( ) [JScript] public override function WriteLine( );

Description

[1577] Sends a carriage return +line feed (CRLF) pair of characters to the HTTP output stream.

[1578] WriteString

[1579] [C#] public void WriteString(string s, int index, int count); [C++] public: void WriteString(String* s, int index, int count); [VB] Public Sub WriteString(ByVal s As String, ByVal index As Integer, ByVal count As Integer) [JScript] public function WriteString(s: String, index: int, count: int);

Description

[1580] Sends a string or a sub-string to the client.

[1581] IHttpAsyncHandler interface (System.Web) WriteString

Description

When implemented by a class, defines the contract that HTTP asynchronous handler objects must implement.

[1582] BeginProcessRequest

[1583] [C#] IAsyncResult BeginProcessRequest(HttpContext context, AsyncCallback cb, object extraData); [C++] IAsyncResult* BeginProcessRequest(HttpContext* context, AsyncCallback* cb, Object* extraData); [VB] Function BeginProcessRequest(ByVal context As HttpContext, ByVal cb As AsyncCallback, ByVal extraData As Object) As IAsyncResult [JScript] function BeginProcessRequest(context: HttpContext, cb AsyncCallback, extraData: Object): IAsyncResult;

Description

[1584] Initiates an asynchronous call to the HTTP handler. Return Value. An System.IAsyncResult that contains information about the status of the process. An System.Web.HttpContext object that provides references to intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests. The System.AsyncCallback to call when the asynchronous method call is complete. If cb is a null reference (Nothing in Visual Basic), the delegate is not called. Any extra data needed to process the request.

[1585] EndProcessRequest

[C#] void EndProcessRequest(IAsyncResult result); [C++] void EndProcessRequest(IAsyncResult* result); [VB] Sub EndProcessRequest(ByVal result As IAsyncResult) [JScript] function EndProcessRequest(result: IAsyncResult);

Description

[1586] Executes clean-up code when the process ends. An System.IAsyncResult that contains information about the status of the process.

[1587] IHttpHandler interface (System.Web) EndProcessRequest

Description

[1588] Defines the contract that ASP.NET implements to synchronously process HTTP Web requests using custom HTTP handlers.

[1589] You can write custom HTTP handlers to process specific, predefined types of HTTP requests in any Common Language Specification (CLS) compliant language. Executable code defined in the HttpHandler classes, rather than conventional ASP or ASP.NET Web pages, responds to these specific requests. HTTP handlers give you a means of interacting with the low-level request and response services of the IIS Web server and provide functionality much like ISAPI extensions but with a simpler programming model.

[1590] IsReusable

[1591] EndProcessRequest

[C#] bool IsReusable {get;} [C++] bool get IsReusable( ); [VB] ReadOnly Property IsReusable As Boolean [JScript] abstract function get IsReusable( ): Boolean;

Description

[1592] Gets a value indicating whether another request can use the System.Web.IIHttpHandler instance.

[1593] You explicitly set the IsReusable property to true or false by code you provide that overrides the IsReusable property accessor.

[1594] ProcessRequest

[C#] void ProcessRequest(HttpContext context); [C++] void ProcessRequest(HttpContext* context); [VB] Sub ProcessRequest(ByVal context As HttpContext) [JScript] function ProcessRequest(context: HttpContext);

Description

[1595] Enables processing of HTTP Web requests by a custom HttpHandler that implements the System.Web.IIHttpHandler interface.

[1596] Place your custom HttpHandler code in the ProcessRequest virtual method as shown in the following example. An System.Web.HttpContext object that provides references to the intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests.

[1597] IHttpHandlerFactory interface (System.Web)

[1598] ProcessRequest

Description

[1599] Defines the contract that class factories must implement to create new System.Web.IIHttpHandler objects.

[1600] A class that implements the IHttpHandlerFactory interface has no behavior except to dynamically manufacture new handler objects—that is, new instances of classes that implement the IHttpHandler interface.

[1601] GetHandler

[1602] [C#] IHttpHandler GetHandler(HttpContext context, string requestType, string url, string pathTranslated); [C++] IHttpHandler* GetHandler(HttpContext* context, String* requestType, String* url, String* pathTranslated); [VB] Function GetHandler(ByVal context As HttpContext, ByVal requestType As String, ByVal url As String, ByVal pathTranslated As String) As IHttpHandler [JScript] function GetHandler(context: HttpContext, requestType: String, url: String, pathTranslated: String): IHttpHandler;

Description

[1603] Returns an instance of a class that implements the IHttpHandler interface. Return Value. A new IHttpHandler object that processes the request. An instance of the System.Web.HttpContext class that provides references to intrinsic server objects (For example, Request, Response, Session, and Server) used to service HTTP requests. The HTTP data transfer method (GET or POST) that the client uses. The System.Web.HttpRequest.RawUrl of the requested resource. The System.Web.HttpRequest.PhysicalApplicationPath to the requested resource.

[1604] ReleaseHandler

[C#] void ReleaseHandler(IHttpHandler handler);

C++] void ReleaseHandler(IHttpHandler* handler); [VB] Sub ReleaseHandler(ByVal handler As IHttpHandler) [JScript] function ReleaseHandler(handler: IHttpHandler);

Description

[1605] Enables a factory to reuse an existing handler instance. The IHttpHandler object to reuse.

[1606] IHttpModule interface (System.Web)

[1607] ReleaseHandler

Description

[1608] Provides module initialization and disposal events to the inheriting class.

[1609] Dispose

[C#] void Dispose( ); [C++] void Dispose( ); [VB] Sub Dispose( ) [JScript] function Dispose( );

Description

[1610] Disposes of the resources (other than memory) used by the module that implements IHttpModule.

[1611] Dispose performs any final cleanup work prior to removal of the module from the execution pipeline.

[1612] Init

[C#] void Init(HttpApplication context); [C++] void Init(HttpApplication* context); [VB] Sub Init(ByVal context As HttpApplication) [JScript] function Init(context: HttpApplication); 25

Description

[1613] Initializes a module and prepares it to handle requests.

[1614] ProcessInfo class (System.Web)

[1615] Init

Description

[1616] Provides information on processes currently executing.

[1617] ProcessInfo

[1618] Example Syntax:

[1619] Init

[C++] public: ProcessInfo( );

[1620] [VB] Public Sub New( ) [JScript] public function ProcessInfo( );

Description

[1621] Initializes a new instance of the System.Web.ProcessInfo class.

[1622] The default constructor initializes all fields to their default values.

[1623] ProcessInfo

[1624] Example Syntax.

[1625] Init

[1626] [C#] public ProcessInfo(DateTime startTime, TimeSpan age, int processID, int requestCount, ProcessStatus status, ProcessShutdownReason shutdownReason, int peakMemoryUsed); [C++] public: ProcessInfo(DateTime startTime, TimeSpan age, int processID, int requestCount, ProcessStatus status, ProcessShutdownReason shutdownReason, int peakMemoryUsed); [VB] Public Sub New(ByVal startTime As DateTime, ByVal age As TimeSpan, ByVal processID As Integer, ByVal requestCount As Integer, ByVal status As ProcessStatus, ByVal shutdownReason As ProcessShutdownReason, ByVal peakMemoryUsed As Integer) [JScript] public function ProcessInfo(startTime: DateTime, age: TimeSpan, processID: int, requestCount: int, status: ProcessStatus, shutdownReason: ProcessShutdownReason, peakMemoryUsed: int); Initializes a new instance of the System.Web.ProcesInfo class.

Description

[1627] Initializes a new instance of the ProcessInfo class and sets internal information indicating the status of the process. A System.DateTime that indicates the time at which the process started. The System.TimeSpan that indicates the time elapsed since the process started. The ID number assigned to the process. The number of start requests for the process. One of the System.Web.ProcessStatus values that indicates the current status of the process. One of the System.Web.ProcessShutdownReason values. The maximum memory used (in bytes).

[1628] Age

[1629] Init

[C#] public TimeSpan Age {get;} [C++] public: _property TimeSpan get_Age( ); [VB] Public ReadOnly Property Age As TimeSpan [JScript] public function get Age( ): TimeSpan;

Description

[1630] Gets the length of time the process has been running.

[1631] PeakMemoryUsed

[1632] Init

[C#] public int PeakMemoryUsed {get;} [C++] public: _property int get_PeakMemoryUsed( ); [VB] Public ReadOnly Property PeakMemoryUsed As Integer [JScript] public function get PeakMemoryUsed( ): int;

Description

[1633] Gets the maximum amount of memory the process has used.

[1634] ProcessID

[1635] Init

[C#] public int ProcessID {get;} [C++] public: _property int get_ProcessID( ); [VB] Public ReadOnly Property ProcessID As Integer [JScript] public function get ProcessID( ): int;

Description

[1636] Gets the ID number assigned to the process.

[1637] RequestCount

[1638] Init

[C#] public int RequestCount {get;} [C++] public: _property int get_RequestCount( ); [VB] Public ReadOnly Property RequestCount As Integer [JScript] public function get RequestCount( ): int;

Description

[1639] Gets the number of start requests for the process.

[1640] ShutdownReason

[1641] Init

[1642] [C#] public ProcessShutdownReason ShutdownReason {get;} [C++] public: _property ProcessShutdownReason get_ShutdownReason( ); [VB] Public ReadOnly Property ShutdownReason As ProcessShutdownReason [JScript] public function get ShutdownReasono: ProcessShutdownReason;

Description

[1643] Gets a value that indicates why the process shut down.

[1644] StartTime

[1645] Init

[C#] public DateTime StartTime {get;} [C++] public: _property DateTime get_StartTime( ); [VB] Public ReadOnly Property StartTime As DateTime [JScript] public function get StartTime( ): DateTime;

Description

[1646] Gets the time at which the process started.

[1647] Status

[1648] Init

[C#] public ProcessStatus Status {get;} [C++] public: _property ProcessStatus get_Status( ); [VB] Public ReadOnly Property Status As ProcessStatus [JScript] public function get Status( ): ProcessStatus;

Description

[1649] Gets the current status of the process.

[1650] SetAll

[1651] [C#] public void SetAll(DateTime startTime, TimeSpan age, int processID, int requestCount, ProcessStatus status, ProcessShutdownReason shutdownReason, int peakMemoryUsed); [C++] public: void SetAll(DateTime startTime, TimeSpan age, int processID, int requestCount, ProcessStatus status, ProcessShutdownReason shutdownReason, int peakMemoryUsed); [VB] Public Sub SetAll(ByVal startTime As DateTime, ByVal age As TimeSpan, ByVal processID As Integer, ByVal requestCount As Integer, ByVal status As ProcessStatus, ByVal shutdownReason As ProcessShutdownReason, ByVal peakMemoryUsed As Integer) [JScript] public function SetAll(startTime: DateTime, age: TimeSpan, processID: int, requestCount: int, status: ProcessStatus, shutdownReason ProcessShutdownReason, peakMemoryUsed int);

Description

[1652] Sets internal information indicating the status of the process. A System.DateTime that indicates the time at which the process started. A System.TimeSpan that indicates the time elapsed since the process started. The ID number assigned to the process. The number of start requests for the process. One of the System.Web.ProcessStatus values that indicates the time elapsed since tha process started. One of the System.Web.ProcessShutdownReason values. The maximum memory used (in bytes).

[1653] ProcessModelInfo class (System.Web)

[1654] ToString

[1655] ProcessModelInfo

[1656] Example Syntax:

[1657] ToString

[1658] GetCurrentProcessInfo

[1659] [C#] public static ProcessInfo GetCurrentProcessInfo( ); [C++] public: static ProcessInfo* GetCurrentProcessInfo( ); [VB] Public Shared Function GetCurrentProcessInfo( ) As ProcessInfo [JScript] public static function GetCurrentProcessInfo( ): ProcessInfo;

[1660] GetHistory

[1661] [C#] public static ProcessInfo[ ] GetHistory(int numRecords); [C++] public: static ProcessInfo* GetHistory(int numRecords) [ ]; [VB] Public Shared Function GetHistory(ByVal numRecords As Integer) As ProcessInfo( ) [JScript] public static function GetHistory(numRecords: int): ProcessInfo[ ];

[1662] ProcessShutdownReason enumeration (System.Web)

[1663] ToString

Description

[1664] Provides enumerated values that indicate why a process has shut down.

[1665] ToString

[C#] public const ProcessShutdownReason IdleTimeout; [C++] public: const ProcessShutdownReason IdleTimeout; [VB] Public Const IdleTimeout As ProcessShutdownReason [JScript] public var IdleTimeout: ProcessShutdownReason;

Description

[1666] Indicates that the process exceeded the allowable idle time.

[1667] ToString

[1668] [C#] public const ProcessShutdownReason MemoryLimitExceeded; [C++] public: const ProcessShutdownReason MemoryLimitExceeded; [VB] Public Const MemoryLimitExceeded As ProcessShutdownReason [JScript] public var MemoryLimitExceeded: ProcessShutdownReason;

Description

[1669] Indicates that the process exceeded the per-process memory limit.

[1670] ToString

[C#] public const ProcessShutdownReason None; [C++] public: const ProcessShutdownReason None; [VB] Public Const None As ProcessShutdownReason [JScript] public var None: ProcessShutdownReason;

Description

[1671] Indicates that the process has not shut down.

[1672] ToString

[C#] public const ProcessShutdownReason PingFailed; [C++] public: const Process ShutdownReason PingFailed; [VB] Public Const PingFailed As ProcessShutdownReason [JScript] public var PingFailed: ProcessShutdownReason;

Description

[1673] ToString

[C#] public const ProcessShutdownReason RequestQueueLimit; [C++] public: const ProcessShutdownReason RequestQueueLimit; [VB] Public Const RequestQueueLimit As ProcessShutdownReason [JScript] public var RequestQueueLimit: ProcessShutdownReason;

Description

[1674] Indicates that the request for a process exceeded the allowable number of processes in the queue.

[1675] ToString

[C#] public const ProcessShutdownReason RequestsLimit; [C++] public: const ProcessShutdownReason RequestsLimit; [VB] Public Const RequestsLimit As ProcessShutdownReason [JScript] public var RequestsLimit: ProcessShutdownReason;

Description

[1676] Indicates that the request for the process exceeded the allowable number of processes.

[1677] ToString

[C#] public const ProcessShutdownReason Timeout; [C++] Public: const ProcessShutdownReason Timeout; [VB] Public Const Timeout As ProcessShutdownReason [JScript] public var Timeout: ProcessShutdownReason;

Description

[1678] Indicates that the process timed out.

[1679] ToString

[C#] public const ProcessShutdownReason Unexpected; [C++] Public: const ProcessShutdownReason Unexpected; [VB] Public Const Unexpected As ProcessShutdownReason [JScript] public var Unexpected: ProcessShutdownReason;

Description

[1680] Indicates that the process shut down unexpectedly.

[1681] ProcessStatus enumeration (System.Web)

[1682] ToString

Description

[1683] Provides enumerated values that indicate the current status of a process.

[1684] ToString

[C#] public const ProcessStatus Alive; [C++] public: const ProcessStatus Alive; [VB] Public Const Alive As ProcessStatus [JScript] public var Alive: ProcessStatus;

Description

[1685] Indicates that the process is running.

[1686] ToString

[C#] public const ProcessStatus ShutDown; [C+++]public: const ProcessStatus ShutDown; [VB] Public Const ShutDown As ProcessStatus [JScript] public var ShutDown: ProcessStatus;

Description

[1687] Indicates that the process has shut down.

[1688] ToString

[C#] public const ProcessStatus ShuttingDown; [C++] public: const ProcessStatus ShuttingDown; [VB] Public Const ShuttingDown As ProcessStatus [JScript] public var ShuttingDown: ProcessStatus;

Description

[1689] Indicates that the process has begun to shut down.

[1690] ToString

[C#] public const ProcessStatus Terminated; [C++] public: const ProcessStatus Terminated; [VB] Public Const Terminated As ProcessStatus [JScript] public var Terminated: ProcessStatus;

Description

[1691] Indicates that the process has terminated.

[1692] TraceContext class (System.Web)

[1693] ToString

Description

[1694] Captures and presents execution details about a Web request. This class cannot be inherited.

[1695] You can use this class to append messages to specific trace categories. For example, if you are creating an instance of the System.Web.UI.WebControls.Calendar class for your application, you might include the trace message “Starting To Render” in a rendering procedure, and “Firing OnChange Event” in an event handling procedure.

[1696] TraceContext

[1697] Example Syntax:

[1698] ToString

[C#] public TraceContext(HttpContext context); [C++] public: TraceContext(HttpContext* context); [VB] Public Sub New(ByVal context As HttpContext) [JScript] public function TraceContext(context: HttpContext);

Description

[1699] Initializes a new instance of the System.Web.TraceContext class. An System.Web.HttpContext that contains information about the current Web request.

[1700] IsEnabled

[1701] ToString

[1702] [C#] public bool IsEnabled {get; set;} [C++] public: _property bool get_IsEnabled( );public: _property void set_IsEnabled(bool); [VB] Public Property IsEnabled As Boolean [JScript] public function get IsEnabled( ): Boolean;public function set IsEnabled(Boolean);

Description

[1703] Indicates whether tracing is enabled for the current Web request.

[1704] Use this flag to check whether your page or application should output tracing information before it writes anything to the trace log. You can set this property to true for a page by including a trace=“true” attribute in the directive. To set the property to true for an entire application, set it in the application's Web.config file.

[1705] TraceMode

[1706] ToString

[1707] [C#] public TraceMode TraceMode {get; set;} [C++] public: _property TraceMode get_TraceMode( );public: _property void set_TraceMode(TraceMode); [VB] Public Property TraceMode As TraceMode [JScript] public function get TraceMode( ): TraceMode;public function set TraceMode(TraceMode);

Description

[1708] Gets or sets the sorted order in which trace messages should be output to a requesting browser.

[1709] Trace messages can be sorted in the order they were processed, or alphabetically by user-defined category.

[1710] Warn

[1711] [C#] public void Warn(string message); [C++] public: void Warn(String* message); [VB] Public Sub Warn(ByVal message As String) [JScript] public function Warn(message: String); Writes trace information to the trace log. Unlike System.Web.TraceContext.Write(System.String), all warnings appear in the log as red text.

Description

[1712] Writes a trace message to the trace log. All warnings appear as in the log as red text. The trace message to write to the log.

[1713] Warn

[1714] [C#] public void Warn(string category, string message); [C++] public: void Warn(String* category, String* message); [VB] Public Sub Warn(ByVal category As String, ByVal message As String) [JScript] public function Warn(category: String, message: String); Writes trace information to the trace log. All warnings appear in the log as red text.

Description

[1715] Writes trace information to the trace log, including any user-defined categories and trace messages. All warnings appear in the log as red text. The trace category that receives the message. The trace message to write to the log.

[1716] Warn

[1717] [C#] public void Warn(string category, string message, Exception errorInfo); [C++] public: void Warn(String* category, String* message, Exception* errorInfo); [VB] Public Sub Warn(ByVal category As String, ByVal message As String, ByVal errorInfo As Exception) [JScript] public function Warn(category: String, message: String, errorInfo Exception);

Description

[1718] Writes trace information to the trace log, including any user-defined categories,trace messages, and error information. All warnings appear in the log as red text. The trace category that receives the message. The trace message to write to the log. An System.Exception that contains information about the error.

[1719] Write

[C#] public void Write(string message); [C++] public: void Write(String* message); [VB] Public Sub Write(ByVal message As String) [JScript] public function Write(message: String); Writes trace information to the trace log.

Description

[1720] Writes a trace message to the trace log. The trace message to write to the log.

[1721] Write

[1722] [C#] public void Write(string category, string message); [C++] public: void Write(String* category, String* message); [VB] Public Sub Write(ByVal category As String, ByVal message As String) [JScript] public function Write(category: String, message: String); Writes trace information to the trace log.

Description

[1723] Writes trace information to the trace log, including a message and any user-defined categories. The trace category that receives the message. The trace message to write to the log.

[1724] Write

[1725] [C#] public void Write(string category, string message, Exception errorInfo); [C++] public: void Write(String* category, String* message, Exception* errorInfo); [VB] Public Sub Write(ByVal category As String, ByVal message As String, ByVal errorInfo As Exception) [JScript] public function Write(category: String, message: String, errorInfo: Exception);

Description

[1726] Writes trace information to the trace log, including any user-defined categories,trace messages, and error information. The trace category that receives the message. The trace message to write to the log. An System.Exception that contains information about the error.

[1727] TraceMode enumeration (System.Web)

[1728] Write

Description

[1729] Specifies in what order trace messages are emitted into the HTML output of a page.

[1730] Write

[C#] public const TraceMode Default; [C++] public: const TraceMode Default; [VB] Public Const Default As TraceMode [JScript] public var Default: TraceMode;

Description

[1731] Specifies the default value of the TraceMode enumeration, which is SortByTime.

System.Web.Caching

[1732] Description

[1733] The System.Web.Caching namespace provides classes for caching frequently used resources on the server. This includes ASP.NET pages, web services, and user controls. Additionally, a cache dictionary is available for you to store frequently used resources, such as hashtables and other data structures.

[1734] Cache class (System.Web.Caching)

Description

[1735] Implements the cache for a Web application.

[1736] One instance of this class is created per application domain, and it remains valid as long as the application domain remains active. Information about an instance of this class is available through the Cache property of the System.Web.HttpContext object. This class cannot be inherited.

[C#] public static readonly DateTime NoAbsoluteExpiration; [C++] public: static DateTime NoAbsoluteExpiration; [VB] Public Shared ReadOnly NoAbsoluteExpiration As DateTime [JScript] public static var NoAbsoluteExpiration: DateTime;

Description

[1737] Used in the absoluteExpiration parameter in an System.Web.Caching.Cache.Insert(System.String,System.Object) method call to indicate the item should never expire. This field is read-only.

[1738] When used, this field sets the absoluteExpiration parameter equal to System.DateTime.MaxValue, which is a constant representing the largest possible DateTime value, 12/31/9999 11:59:59 PM.

[C#] public static readonly TimeSpan NoSlidingExpiration; [C++] public: static TimeSpan NoSlidingExpiration; [VB] Public Shared ReadOnly NoSlidingExpiration As TimeSpan [JScript] public static var NoSlidingExpiration: TimeSpan;

Description

[1739] Used as the slidingExpiration parameter in an System.Web.Caching.Cache.Insert(System.String,System.Object) method call to disable sliding expirations. This field is read-only.

[1740] When used, this field sets the slidingExpiration parameter equal to the System.TimeSpan.Zero field, which has a constant value of zero. The cached item then expires in accordance with the absoluteExpiration parameter.

[1741] Constructors:

[1742] Cache

[1743] Example Syntax:

[C#] public Cache( ); [C++] public: Cache( ); [VB] Public Sub New( ) [JScript] public function Cache( );

[1744] Properties:

[1745] Count

[C#] public int Count {get;} [C++] public: _property int get_Count( ); [VB] Public ReadOnly Property Count As Integer [JScript] public function get Count( ): int;

Description

[1746] Gets the number of items stored in the cache.

[1747] This property can be useful when monitoring your application's performance or when using ASP.NET tracing functionality.

[1748] Item

[1749] [C#] public object this[string key] {get; set;} [C++] public: _property Object* get_Item(String* key);public: _property void set_Item(String* key, Object*); [VB] Public Default Property Item(ByVal key As String) As Object [JScript] returnValue=CacheObject.Item(key);CacheObject.Item(key)=returnValue;

Description

[1750] Gets or sets the cache item at the specified key.

[1751] You can use this property to retrieve the value of a specified cache item, or to add an item and a key for it to the cache. A System.String object that represents the key for the cache item.

[1752] Methods:

[1753] Add

[1754] [C#] public object Add(string key, object value, CacheDependency dependencies, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority, CacheItemRemovedCallback onRemoveCallback); [C++] public: Object* Add(String* key, Object* value, CacheDependency* dependencies, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority, CacheItemRemovedCallback* onRemoveCallback); [VB] Public Function Add(ByVal key As String, ByVal value As Object, ByVal dependencies As CacheDependency, ByVal absoluteExpiration As DateTime, ByVal slidingExpiration As TimeSpan, ByVal priority As CacheItemPriority, ByVal onRemoveCallback As CacheItemRemovedCallback) As Object [JScript] public function Add(key: String, value: Object, dependencies: CacheDependency, absoluteExpiration: DateTime, slidingExpiration: TimeSpan, priority: CacheItemPriority, onRemoveCallback: CacheItemRemovedCallback): Object;

Description

[1755] Adds the specified item to the System.Web.Caching.Cache object with dependencies, expiration and priority policies, and a delegate you can use to notify your application when the inserted item is removed from the Cache. Return Value: The System.Object item added to the Cache. The cache key used to reference the item. The item to be added to the cache. The file or cache key dependencies for the item. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this paramter contains null. The time at which the added object expires and is removed from the cache. The interval between the time the added object was last accessed and when that object expires. If this value is the equivalent of 20 minutes, the object expires and is removed from the cache 20 minutes after it is last accessed. The relative cost of the object, as expressed by the System.Web.Caching.CacheItemPriority enumeration. The cache uses this value when it evicts objects; objects with a lower cost are removed from the cache before objects with a higher cost. A delegate that, if provided, is called when an object is removed from the cache. You can use this to notify applications when their objects are deleted from the cache.

[1756] Get

[C#] public object Get(string key); [C++] public: Object* Get(String* key); [VB] Public Function Get(ByVal key As String) As Object [JScript] public function Get(key: String): Object;

Description

[1757] Retrieves the specified item from the System.Web.Caching.Cache object.

Return Value. The retrieved cache item, or null if the key is not found. The identifier for the cache item to retrieve.

[1758] GetEnumerator

[C#] public IDictionaryEnumerator GetEnumerator( ); [C++] public: IDictionaryEnumerator* GetEnumerator( ); [VB] Public Function GetEnumerator( ) As IDictionaryEnumerator [JScript] public function GetEnumerator( ): IDictionaryEnumerator;

Description

[1759] Retrieves a dictionary enumerator used to iterate through the key settings and their values contained in the cache.

Return Value. An enumerator to iterate through the System.Web.Caching.Cache object.

[1760] Items can be added or removed from the cache while this method is enumerating through the items.

[1761] Insert

[1762] [C#] public void Insert(string key, object value); [C++] public: void Insert(String* key, Object* value); [VB] Public Sub Insert(ByVal key As String, ByVal value As Object) [JScript] public function Insert(key: String, value: Object); Inserts an item into the System.Web.Caching.Cache object.

Description

[1763] Inserts an item into the System.Web.Caching.Cache object with a cache key to reference its location and using default values provided by the System.Web.Caching.CacheItemPriority and System.Web.Caching.CacheItemPriorityDecay enumerations. The cache key used to reference the item. The object to be inserted into the cache.

[1764] Insert

[1765] [C#] public void Insert(string key, object value, CacheDependency dependencies); [C++] public: void Insert(String* key, Object* value, CacheDependency* dependencies); [VB] Public Sub Insert(ByVal key As String, ByVal value As Object, ByVal dependencies As CacheDependency) [JScript] public function Insert(key: String, value: Object, dependencies CacheDependency);

Description

[1766] Inserts an object into the System.Web.Caching.Cache that has file or key dependencies. The cache key used to identify the item. The object to be inserted in the cache. The file or cache key dependencies for the inserted object. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this parameter contains null.

[1767] Insert

[1768] [C#] public void Insert(string key, object value, CacheDependency dependencies, DateTime absoluteExpiration, TimeSpan slidingExpiration); [C++] public: void Insert(String* key, Object* value, CacheDependency* dependencies, DateTime absoluteExpiration, TimeSpan slidingExpiration); [VB] Public Sub Insert(ByVal key As String, ByVal value As Object, ByVal dependencies As CacheDependency, ByVal absoluteExpiration As DateTime, ByVal slidingExpiration As TimeSpan) [JScript] public function Insert(key: String, value: Object, dependencies CacheDependency, absoluteExpiration: DateTime, slidingExpiration: TimeSpan);

Description

[1769] Inserts an object into the System.Web.Caching.Cache with dependencies and expiration policies.

[1770] If the slidingExpiration parameter is set to NoSlidingExpiration, sliding expiration is disabled. If you set the slidingExpiration parameter to greater than System.TimeSpan.Zero, the absoluteExpiration parameter is set to System.DateTime.Now plus the value contained in the slidingExpiration parameter. If the item is requested from the cache before the amount of time specified by the absoluteExpiration parameter, the item will be placed in the cache again, and absoluteExpiration will again be set to DateTime.Now plus the value contained in the slidingExpiration parameter. If the item is not requested from the cache before the date in the absoluteExpiration parameter, the item is removed from the cache. The cache key used to reference the object. The object to be inserted in the cache. The file or cache key dependencies for the inserted object. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this parameter contains null. The time at which the inserted object expires and is removed from the cache. The interval between the time the inserted object is last accessed and when that object expires. If this value is the equivalent of 20 minutes, the object will expire and be removed from the cache 20 minutes after it was last accessed.

[1771] Insert

[1772] [C#] public void Insert(string key, object value, CacheDependency dependencies, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority, CacheItemRemovedCallback onRemoveCallback); [C++] public: void Insert(String* key, Object* value, CacheDependency* dependencies, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemPriority priority, CacheItemRemovedCallback* onRemoveCallback); [VB] Public Sub Insert(ByVal key As String, ByVal value As Object, ByVal dependencies As CacheDependency, ByVal absoluteExpiration As DateTime, ByVal slidingExpiration As TimeSpan, ByVal priority As CacheItemPriority, ByVal onRemoveCallback As CacheItemRemovedCallback) [JScript] public function Insert(key: String, value: Object, dependencies: CacheDependency, absoluteExpiration: DateTime, slidingExpiration: TimeSpan, priority: CacheItemPriority, onRemoveCallback: CacheItemRemovedCallback);

Description

[1773] Inserts an object into the System.Web.Caching.Cache object with dependencies, expiration and priority policies, and a delegate you can use to notify your application when the inserted item is removed from the Cache. The cache key used to reference the object. The object to be inserted in the cache. The file or cache key dependencies for the item. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this parameter contains null. The time at which the inserted object expires and is removed from the cache. The interval between the time the inserted object was last accessed and when that object expires. If this value is the equivalent of 20 minutes, the object will expire and be removed from the cache 20 minutes after it was last accessed. The cost of the object relative to other items stored in the cache, as expressed by the System.Web.Caching.CacheItemPriority enumeration. This value is used by the cache when it evicts objects; objects with a lower cost are removed from the cache before objects with a higher cost. A delegate that, if provided, will be called when an object is removed from the cache. You can use this to notify applications when their objects are deleted from the cache.

[1774] Remove

[C#] public object Remove(string key); [C++] public: Object* Remove(String* key); [VB] Public Function Remove(ByVal key As String) As Object [JScript] public function Remove(key: String): Object;

Description

[1775] Removes the specified item from the application's System.Web.Caching.Cache object.

Return Value. The item removed from the Cache. If the value in the key parameter is not found, returns null. A System.String identifier for the cache item to remove.

[1776] IEnumerable.GetEnumerator

[C#] IEnumerator IEnumerable.GetEnumerator( ); [C++] IEnumerator* IEnumerable::GetEnumerator( ); [VB] Function GetEnumerator( ) As IEnumerator Implements IEnumerable.GetEnumerator [JScript] function IEnumerable.GetEnumerator( ): IEnumerator;

[1777] CacheDependency class (System.Web.Caching)

[1778] ToString

Description

[1779] Tracks cache dependencies, which can be files, directories, or keys to other objects in your application's System.Web.Caching.Cache. This class cannot be inherited.

[1780] You can add items with dependencies to your application's cache with the System.Web.Caching.Cache.Add(System.String,System.Object,System.Web. Caching.CacheDependency,System.DateTime,System.TimeSpan,System.Web. Caching.CacheItemPriority,System.Web.Caching.CacheItemRemovedCallback) and System.Web.Caching.Cache.Insert(System.String,System.Object) methods.

[1781] CacheDependency

[1782] Example Syntax:

[1783] ToString

[1784] [C#] public CacheDependency(string filename); [C++] public: CacheDependency(String* filename); [VB] Public Sub New(ByVal filename As String) [JScript] public function CacheDependency(filename: String); Initializes a new instance of the System.Web.Caching.CacheDependency class.

Description

[1785] Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors a file or directory for changes. The path to a file or directory that the cached object is dependent upon. When this resource changes, the cached object becomes obsolete and is removed from the cache.

[1786] CacheDependency

[1787] Example Syntax:

[1788] ToString

[C#] public CacheDependency(string[ ] filenames); [C++] public: CacheDependency(String* filenames _gc[ ]; [VB] Public Sub New(ByVal filenames( ) As String) [JScript] public function CacheDependency(filenames: String[ ]);

Description

[1789] Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories) for changes.

[1790] If any of the files or directories in the array were to change or be removed from the array, the cached item becomes obsolete and is removed from the application's System.Web.Caching.Cache object. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache.

[1791] CacheDependency

[1792] Example Syntax:

[1793] ToString

[1794] [C#] public CacheDependency(string filename, DateTime start); [C++] public: CacheDependency(String* filename, DateTime start); [VB] Public Sub New(ByVal filename As String, ByVal start As DateTime) [JScript] public function CacheDependency(filename: String, start: DateTime);

Description

[1795] Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors a file or directory for changes and indicates when change tracking is to begin. The path to a file or directory that the cached object is dependent upon. When this resource changes, the cached object becomes obsolete and is removed from the cache. The time when change tracking begins.

[1796] CacheDependency

Example Syntax:

[1797] ToString

[1798] [C#] public CacheDependency(string[ ] filenames, DateTime start); [C++] public: CacheDependency(String* filenames _gc[ ], DateTime start); [VB] Public Sub New(ByVal filenames( ) As String, ByVal start As DateTime) [JScript] public function CacheDependency(filenames: String[ ], start DateTime);

Description

[1799] Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories) for changes and specifies a time when change monitoring begins. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. The time when change tracking begins.

[1800] CacheDependency

[1801] Example Syntax:

[1802] ToString

[1803] [C#] public CacheDependency(string[ ] filenames, string[ ] cachekeys); [C++] public: CacheDependency(String* filenames _gc[ ], String* cachekeys _gc[ ]; [VB] Public Sub New(ByVal filenames( ) As String, ByVal cachekeys( ) As String) [JScript] public function CacheDependency(filenames: String[ ], cachekeys: String[ ]);

Description

[1804] Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories), an array of cache keys, or both for changes. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. An array of cache keys that the new object monitors for changes. When any of these cache keys change, the cached object associated with this dependency object becomes obsolete and is removed from the cache.

[1805] CacheDependency

[1806] Example Syntax:

[1807] ToString

[1808] [C#] public CacheDependency(string[ ] filenames, string[ ] cachekeys, CacheDependency dependency); [C++] public: CacheDependency(String* filenames _gc[ ], String* cachekeys _gc[ ], CacheDependency* dependency); [VB] Public Sub New(ByVal filenames( ) As String, ByVal cachekeys( ) As String, ByVal dependency As CacheDependency) [JScript] public function CacheDependency(filenames: String[ ], cachekeys String[ ], dependency: CacheDependency);

Description

[1809] Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories), an array of cache keys, or both for changes. It also makes itself dependent upon a separate instance of the CacheDependency class. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. An array of cache keys that the new object monitors for changes. When any of these cache keys change, the cached object associated with this dependency object becomes obsolete and is removed from the cache. Another instance of the CacheDependency class that this instance is dependent upon.

[1810] CacheDependency

[1811] Example Syntax:

[1812] ToString

[1813] [C#] public CacheDependency(string[ ] filenames, string[ ] cachekeys, DateTime start); [C++] public: CacheDependency(String* filenames _gc[ ], String* cachekeys _gc[ ], DateTime start); [VB] Public Sub New(ByVal filenames( ) As String, ByVal cachekeys( ) As String, ByVal start As DateTime) [JScript] public function CacheDependency(filenames: String[ ], cachekeys String[ ], start: DateTime);

Description

[1814] Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories), an array of cache keys, or both for changes. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. An array of cache keys that the new object monitors for changes. When any of these cache keys change, the cached object associated with this dependency object becomes obsolete and is removed from the cache. The time when change tracking begins.

[1815] CacheDependency

[1816] Example Syntax:

[1817] ToString

[1818] [C#] public CacheDependency(string[ ] filenames, string[ ] cachekeys, CacheDependency dependency, DateTime start); [C++] public: CacheDependency(String* filenames _gc[ ], String* cachekeys _gc[ ], CacheDependency* dependency, DateTime start); [VB] Public Sub New(ByVal filenames( ) As String, ByVal cachekeys( ) As String, ByVal dependency As CacheDependency, ByVal start As DateTime) [JScript] public function CacheDependency(filenames: String[ ], cachekeys String[ ], dependency: CacheDependency, start: DateTime);

Description

[1819] Initializes a new instance of the System.Web.Caching.CacheDependency class that monitors an array of file paths (to files or directories), an array of cache keys, or both for changes. It also makes itself dependent upon another instance of the CacheDependency class and a time when the change monitoring begins. An array of file paths (to files or directories) that the cached object is dependent upon. When any of these resources change, the cached object becomes obsolete and is removed from the cache. An array of cache keys that the new object monitors for changes. When any of these cache keys change, the cached object associated with this dependency object becomes obsolete and is removed from the cache. Another instance of the CacheDependency class that this instance is dependent upon. The time when change tracking begins.

[1820] Dispose

[C#] public void Dispose( ); [C++] public: _sealed void Dispose( ); [VB] NotOverridable Public Sub Dispose( ) [JScript] public function Dispose( );

Description

[1821] Releases the resources used by the System.Web.Caching.CacheDependency object.

[1822] CacheItemPriority enumeration (System.Web.Caching)

[1823] ToString

Description

[1824] Specifies the relative priority of items stored in the System.Web.Caching.Cache.

[1825] When the Web server hosting an ASP.NET application runs low on memory, the Cache selectively purges items to free system memory. When an item is added to the cache, you can assign it a relative priority compared to the other items stored in the cache. Items you assign higher priority values to are less likely to be deleted from the cache when the server is processing a large number of requests, while items you assign lower priority values are more likely to be deleted. The default is Normal.

[1826] ToString

[C#] public const CacheItemPriority AboveNormal; [C++] public: const CacheItemPriority AboveNormal; [VB] Public Const AboveNormal As CacheItemPriority [JScript] public var AboveNormal: CacheItemPriority;

Description

[1827] Cache items with this priority level are less likely to be deleted as the server frees system memory than those assigned a Normal priority.

[1828] ToString

[C#] public const CacheItemPriority BelowNormal; [C++] public: const CacheItemPriority BelowNormal; [VB] Public Const BelowNormal As CacheItemPriority [JScript] public var BelowNormal: CacheItemPriority;

Description

[1829] Cache items with this priority level are more likely to be deleted from the cache as the server frees system memory than items assigned a Normal priority.

[1830] ToString

[C#] public const CacheItemPriority Default; [C++] public: const CacheItemPriority Default; [VB] Public Const Default As CacheItemPriority [JScript] public var Default: CacheItemPriority;

Description

[1831] The default value for a cached item's priority is Normal.

[1832] ToString

[C#] public const CacheItemPriority High; [C++] public: const CacheItemPriority High; [VB] Public Const High As CacheItemPriority [JScript] public var High: CacheItemPriority;

Description

[1833] Cache items with this priority level are the least likely to be deleted from the cache as the server frees system memory.

[1834] ToString

[C#] public const CacheItemPriority Low; [C++] public: const CacheItemPriority Low; [VB] Public Const Low As CacheItemPriority [JScript] public var Low: CacheItemPriority;

Description

[1835] Cache items with this priority level are the most likely to be deleted from the cache as the server frees system memory.

[1836] ToString [C#] public const CacheItemPriority Normal; [C++] public: const CacheItemPriority Normal; [VB] Public Const Normal As CacheItemPriority [JScript] public var Normal: CacheItemPriority;

Description

[1837] Cache items with this priority level are likely to be deleted from the cache as the server frees system memory only after those items with Low or BelowNormal priority. This is the default.

[1838] ToString

[C#] public const CacheItemPriority NotRemovable; [C++] public: const CacheItemPriority NotRemovable; [VB] Public Const NotRemovable As CacheItemPriority [JScript] public var NotRemovable: CacheItemPriority;

Description

[1839] The cache items with this priority level will not be deleted from the cache as the server frees system memory.

[1840] CacheItemRemovedCallback delegate (System.Web.Caching)

[1841] ToString

Description

[1842] Defines a callback method for notifying applications when a cached item is removed from the System.Web.Caching.Cache. The index location for the item removed from the cache. The System.Object item removed from the cache. The reason the item was removed from the cache, as specified by the System.Web.Caching.CacheItemRemovedReason enumeration.

[1843] CacheItemRemovedReason enumeration (System.Web.Caching)

[1844] ToString

Description

[1845] Specifies the reason an item was removed from the System.Web.Caching.Cache.

[1846] This enumeration works in concert with the System.Web.Caching.CacheItemRemovedCallback delegate to notify your ASP.NET applications when and why an object was removed from the System.Web.Caching.Cache.

[1847] ToString

[C#] public const CacheItemRemovedReason DependencyChanged; [C++] public: const CacheItemRemovedReason DependencyChanged; [VB] Public Const DependencyChanged As CacheItemRemovedReason [JScript] public var DependencyChanged: CacheItemRemovedReason;

Description

[1848] The item is removed from the cache because a file or key dependency changed.

[1849] ToString

[C#] public const CacheItemRemovedReason Expired; [C++] public: const CacheItemRemovedReason Expired; [VB] Public Const Expired As CacheItemRemovedReason [JScript] public var Expired: CacheItemRemovedReason;

Description

[1850] The item is removed from the cache because it expired.

[1851] ToString

[C#] public const CacheItemRemovedReason Removed; [C++] public: const CacheItemRemovedReason Removed; [VB] Public Const Removed As CacheItemRemovedReason [JScript] public var Removed: CacheItemRemovedReason;

Description

[1852] The item is removed fro

System.Web.Configuration

Description

[1853] The System.Web.Configuration namespace contains classes that are used to set up ASP.NET configuration.

[1854] AuthenticationMode enumeration (System.Web.Configuration)

Description

[1855] Provides enumerated values that specify the authentication mode for an application.

[C#] public const AuthenticationMode Forms; [C++] public: const AuthenticationMode Forms; [VB] Public Const Forms As AuthenticationMode [JScript] public var Forms: AuthenticationMode;

Description

[1856] Specifies ASP.NET forms-based authentication as the default authentication mode.

[C#] public const AuthenticationMode None; [C++] public: const AuthenticationMode None; [VB] Public Const None As AuthenticationMode [JScript] public var None: AuthenticationMode;

Description

[1857] Specifies no authentication. Only anonymous users are expected. Also, applications can handle events to provide their own authentication.

[C#] public const AuthenticationMode Passport; [C++] public: const AuthenticationMode Passport; [VB] Public Const Passport As AuthenticationMode [JScript] public var Passport: AuthenticationMode;

Description

[1858] Specifies Microsoft Passport authentication as the default authentication mode.

[C#] public const AuthenticationMode Windows; [C++] public: const AuthenticationMode Windows; [VB] Public Const Windows As AuthenticationMode [JScript] public var Windows: AuthenticationMode;

Description

[1859] Specifies Windows authentication as the default authentication mode. Use this mode when using any form of Internet Information Services (IIS) authentication: Basic, Digest, Integrated Windows authentication (NTLM/Kerberos), or certificates.

[1860] Methods:

[1861] ClientTargetSectionHandler class (System.Web.Configuration)

[1862] ToString

Description

[1863] Constructors:

[1864] ClientTargetSectionHandler

[1865] Example Syntax:

[1866] ToString

[C#] public ClientTargetSectionHandler( ); [C++] public: ClientTargetSectionHandler( ); [VB] Public Sub New( ) [JScript] public function ClientTargetSectionHandler( );

[1867] Properties:

[1868] KeyAttributeName

[1869] ToString

[1870] [C#] protected override string KeyAttributeName {get;} [C++] protected: property virtual String* get KeyAttributeName( ); [VB] Overrides Protected ReadOnly Property KeyAttributeName As String [JScript] protected function get KeyAttributeName( ): String;

Description

[1871] Gets the name of the key attribute tag. This property is overidden by derived classes to change the name of the key attribute tag. The default is “key”.

[1872] ValueAttributeName

[1873] ToString

[1874] [C#] protected override string ValueAttributeName {get;} [C++] protected: property virtual String* get ValueAttributeName( ); [VB] Overrides Protected ReadOnly Property ValueAttributeName As String [JScript] protected function get ValueAttributeName( ): String;

Description

[1875] Gets the name of the value tag. This property may be overidden by derived classes to change the name of the value tag. The default is “value”.

[1876] FormsAuthPasswordFormat enumeration (System.Web.Configuration)

[1877] ToString

Description

[1878] Provides enumerated values that specify the encryption format for storing passwords.

[1879] ToString

[C#] public const FormsAuthPasswordFormat Clear; [C++] public: const FormsAuthPasswordFormat Clear; [VB] Public Const Clear As FormsAuthPasswordFormat [JScript] public var Clear: FormsAuthPasswordFormat;

Description

[1880] Specifies that passwords are not encrypted.

[1881] ToString

[C#] public const FormsAuthPasswordFormat MD5; [C++] public: const FormsAuthPasswordFormat MD5; [VB] Public Const MD5 As FormsAuthPasswordFormat [JScript] public var MD5: FormsAuthPasswordFormat;

Description

[1882] Specifies that passwords are encrypted using the MD5 hash algorithm.

[1883] ToString

[C#] public const FormsAuthPasswordFormat SHA1; [C++] public: const FormsAuthPasswordFormat SHA1; [VB] Public Const SHA1 As FormsAuthPasswordFormat [JScript] public var SHA1: FormsAuthPasswordFormat;

Description

[1884] Specifies that passwords are encrypted using the SHA1 hash algorithm.

[1885] FormsProtectionEnum enumeration (System.Web.Configuration)

[1886] ToString

Description

[1887] Provides enumerated values that are used to specify the forms protection method.

[1888] ToString

[C#] public const FormsProtectionEnum All; [C++] public: const FormsProtectionEnum All; [VB] Public Const All As FormsProtectionEnum [JScript] public var All: FormsProtectionEnum;

Description

[1889] Specifies that the application uses both data validation and encryption to protect the cookie. This option uses the configured data validation algorithm (based on the element). Triple-DES (3DES) is used for encryption, if it is available and if the key is at least 48 bytes longs.

[1890] ToString

[C#] public const FormsProtectionEnum Encryption; [C++] public: const FormsProtectionEnum Encryption; [VB] Public Const Encryption As FormsProtectionEnum [JScript] public var Encryption: FormsProtectionEnum;

Description

[1891] Specifies that the cookie is encrypted using Triple-DES or DES, but data validation is not performed on the cookie. Cookies used this way might be subject to plain-text security attacks.

[1892] ToString

[C#] public const FormsProtectionEnum None; [C++] public: const FormsProtectionEnum None; [VB] Public Const None As FormsProtectionEnum [JScript] public var None: FormsProtectionEnum;

Description

[1893] Specifies that both encryption and validation are disabled for sites that are using cookies only for personalization and have weaker security requirements. Using cookies in this manner is not recommended; however, it is the least resource-intensive way to enable personalization using the NET Framework.

[1894] ToString

[C#] public const FormsProtectionEnum Validation; [C++] public: const FormsProtectionEnum Validation; [VB] Public Const Validation As FormsProtectionEnum [JScript] public var Validation: FormsProtectionEnum;

Description

[1895] Specifies that the application uses a validation scheme to verify that the contents of an encrypted cookie have not been altered in transit. The cookie is created by concatenating a validation key with the cookie data, computing a Message Authentication Code (MAC), and appending the MAC to the outgoing cookie.

[1896] HttpCapabilitiesBase class (System.Web.Configuration)

[1897] ToString

Description

[1898] Defines the base class for client browser capabilities.

[1899] HttpCapabilitiesBase

[1900] Example Syntax:

[1901] ToString

[C#] public HttpCapabilitiesBase( ); [C++] public: HttpCapabilitiesBase( ); [VB] Public Sub New( ) [JScript] public function HttpCapabilitiesBase( );

[1902] Item

[1903] ToString

[1904] [C#] public virtual string this[string key] {get;} [C++] public: property virtual String* get Item(String* key); [VB] Overridable Public Default ReadOnly Property Item(ByVal key As String) As String [JScript] returnValue=HttpCapabilitiesBaseObject.Item(key);

Description

[1905] Allows access to individual dictionary values. The name of the dictionary value to retrieve.

[1906] GetConfigCapabilities

[1907] [C#] public static HttpCapabilitiesBase GetConfigCapabilities(string configKey, HttpRequest request); [C++] public: static HttpCapabilitiesBase* GetConfigCapabilities(String* configKey, HttpRequest* request); [VB] Public Shared Function GetConfigCapabilities(ByVal configKey As String, ByVal request As HttpRequest) As HttpCapabilitiesBase [JScript] public static function GetConfigCapabilities(configKey: String, request: HttpRequest): HttpCapabilitiesBase;

Description

[1908] Returns individual browser capabilities for the current reqest. The name of the requested browser capability. The current System.Web.HttpContext.Request

[1909] Init

[C#] protected virtual void Init( ); [C++] protected: virtual void Init( ); [VB] Overridable Protected Sub Init( )

System.Web.Hosting

Description

[1910] AppDomainFactory class (System.Web.Hosting)

Description

[1911] Constructors:

[1912] AppDomainFactory

[1913] Example Syntax:

[C#] public AppDomainFactory( ); [C++] public: AppDomainFactory( ); [VB] Public Sub New( ) [JScript] public function AppDomainFactory( );

[1914] Methods:

[1915] Create

[1916] [C#] public object Create(string module, string typeName, string appld, string appPath, string strUrlOfAppOrigin, int iZone); [C++] public: _sealed Object* Create(String* module, String* typeName, String* appld, String* appPath, String* strUrlOfAppOrigin, int iZone); [VB] NotOverridable Public Function Create(ByVal module As String, ByVal typeName As String, ByVal appld As String, ByVal appPath As String, ByVal strUrlOfAppOrigin As String, ByVal iZone As Integer) As Object [JScript] public function Create(module: String, typeName: String, appld: String, appPath: String, strUrlOfAppOrigin: String, iZone: int): Object;

Description

[1917] ApplicationHost class (System.Web.Hosting)

[1918] ToString

Description

[1919] CreateApplicationHost

[1920] [C#] public static object CreateApplicationHost(Type hostType, string virtualDir, string physicalDir); [C++] public: static Object* CreateApplicationHost(Type* hostType, String* virtualDir, String* physicalDir); [VB] Public Shared Function CreateApplicationHost(ByVal hostType As Type, ByVal virtualDir As String, ByVal physicalDir As String) As Object [JScript] public static function CreateApplicationHost(hostType: Type, virtualDir: String, physicalDir: String): Object;

Description

[1921] IAppDomainFactory interface (System.Web.Hosting)

[1922] ToString

Description

[1923] Create

[1924] [C#] object Create(in string module, in string typeName, in string appld, in string appPath, in string strUrlOfAppOrigin, in int iZone); [C++] Object* Create(_in String* module, _in String* typeName, _in String* appld, _in String* appPath, _in String* strUrlOfAppOrigin, _in int iZone); [VB] Function Create(ByVal module As String, ByVal typeName As String, ByVal appld As String, ByVal appPath As String, ByVal strUrlOfAppOrigin As String, ByVal iZone As Integer) As Object [JScript] function Create(in module: String, in typeName: String, in appld: String, in appPath: String, in strUrlOfAppOrigin: String, in iZone: int): Object;

Description

[1925] IISAPIRuntime interface (System.Web.Hosting)

[1926] Create

Description

[1927] DoGCCollect

[C#] void DoGCCollect( ); [C++] void DoGCCollect( ); [VB] Sub DoGCCollect( ) [JScript] function DoGCCollect( );

Description

[1928] ProcessRequest

[1929] [C#] int ProcessRequest(in IntPtr ecb, in int useProcessModel); [C++] int ProcessRequest(_in IntPtr ecb, _in int useProcessModel); [VB] Function ProcessRequest(ByVal ecb As IntPtr, ByVal useProcessModel As Integer) As Integer [JScript] function ProcessRequest(in ecb: IntPtr, in useProcessModel: int): int;

Description

[1930] StartProcessing

[C#] void StartProcessing( ); [C++] void StartProcessing( ); [VB] Sub StartProcessing( ) [JScript] function StartProcessing( );

Description

[1931] StopProcessing

[C#] void StopProcessing( ); [C++] void StopProcessing( ); [VB] Sub StopProcessing( ) [JScript] function StopProcessing( );

Description

[1932] ISAPIRuntime class (System.Web.Hosting)

[1933] StopProcessing

Description

[1934] ISAPIRuntime

[1935] Example Syntax:

[1936] StopProcessing

[C#] public ISAPIRuntime( ); [C++] public: ISAPIRuntime( ); [VB] Public Sub New( ) [JScript] public function ISAPIRuntime( );

[1937] DoGCCollect

[C#] public void DoGCCollect( ); [C++] public: _sealed void DoGCCollect( ); [VB] NotOverridable Public Sub DoGCCollect( ) [JScript] public function DoGCCollect( );

Description

[1938] ProcessRequest

[1939] [C#] public int ProcessRequest(IntPtr ecb, int iWRType); [C++] public: _sealed int ProcessRequest(IntPtr ecb, int iWRType); [VB] NotOverridable Public Function ProcessRequest(ByVal ecb As IntPtr, ByVal iWRType As Integer) As Integer [JScript] public function ProcessRequest(ecb: IntPtr, iWRType: int): int;

Description

[1940] StartProcessing

[C#] public void StartProcessing( ); [C++] public: _sealed void StartProcessing( ); [VB] NotOverridable Public Sub StartProcessing( ) [JScript] public function StartProcessing( );

Description

[1941] StopProcessing

[C#] public void StopProcessing( ); [C++] public: _sealed void StopProcessing( ); [VB] NotOverridable Public Sub StopProcessing( ) [JScript] public function StopProcessing( );

Description

[1942] SimpleWorkerRequest class (System.Web.Hosting)

[1943] ToString

Description

[1944] SimpleWorkerRequest

[1945] Example Syntax:

[1946] ToString

[1947] [C#] public SimpleWorkerRequest(string page, string query, TextWriter output); [C++] public: SimpleWorkerRequest(String* page, String* query, TextWriter* output); [VB] Public Sub New(ByVal page As String, ByVal query As String, ByVal output As TextWriter) [JScript] public function SimpleWorkerRequest(page: String, query: String, output: TextWriter);

Description

[1948] SimpleWorkerRequest

[1949] Example Syntax:

[1950] ToString

[1951] [C#] public SimpleWorkerRequest(string appVirtualDir, string appPhysicalDir, string page, string query, TextWriter output); [C++] public: SimpleWorkerRequest(String* appVirtualDir, String* appPhysicalDir, String* page, String* query, TextWriter* output); [VB] Public Sub New(ByVal appVirtualDir As String, ByVal appPhysicalDir As String, ByVal page As String, ByVal query As String, ByVal output As TextWriter) [JScript] public function SimpleWorkerRequest(appVirtualDir: String, appPhysicalDir: String, page: String, query: String, output: TextWriter);

Description

Properties:

[1952] MachineConfigPath

[1953] ToString

[C#] public override string MachineConfigPath {get;} [C++] public: _property virtual String* get_MachineConfigPath( ); [VB] Overrides Public ReadOnly Property MachineConfigPath As String [JScript] public function get MachineConfigPath( ): String;

Description

[1954] MachineInstallDirectory

[1955] ToString

[1956] [C#] public override string MachineInstallDirectory {get;} [C++] public: _property virtual String* get_MachineInstallDirectory( ); [VB] Overrides Public ReadOnly Property MachineInstallDirectory As String [JScript] public function get MachineInstallDirectory( ): String;

Description

[1957] EndOfRequest

[C#] public override void EndOfRequest( ); [C++] public: void EndOfRequest( ); [VB] Overrides Public Sub EndOfRequest( ) [JScript] public override function EndOfRequest( );

Description

[1958] FlushResponse

[C#] public override void FlushResponse(bool finalFlush); [C++] public: void FlushResponse(bool finalFlush); [VB] Overrides Public Sub FlushResponse(ByVal finalFlush As Boolean) [JScript] public override function FlushResponse(finalFlush: Boolean);

Description

[1959] GetAppPath

[C#] public override string GetAppPath( ); [C++] public: String* GetAppPath( ); [VB] Overrides Public Function GetAppPath( ) As String [JScript] public override function GetAppPath( ): String;

Description

[1960] GetAppPathTranslated

[C#] public override string GetAppPathTranslated( ); [C++] public: String* GetAppPathTranslated( ); [VB] Overrides Public Function GetAppPathTranslated( ) As String [JScript] public override function GetAppPathTranslated( ): String;

Description

[1961] GetFilePath

[C#] public override string GetFilePath( ); [C++] public: String* GetFilePath( ); [VB] Overrides Public Function GetFilePath( ) As String [JScript] public override function GetFilePath( ): String;

Description

[1962] GetFilePathTranslated

[C#] public override string GetFilePathTranslated( ); [C++] public: String* GetFilePathTranslated( ); [VB] Overrides Public Function GetFilePathTranslated( ) As String [JScript] public override function GetFilePathTranslated( ): String;

Description

[1963] GetHttpVerbName

[C#] public override string GetHttpVerbName( ); [C++] public: String* GetHttpVerbName( ); [VB] Overrides Public Function GetHttpVerbName( ) As String [JScript] public override function GetHttpVerbName( ): String;

Description

[1964] GetHttpVersion

[C#] public override string GetHttpVersion( ); [C++] public: String* GetHttpVersion( ); [VB] Overrides Public Function GetHttpVersion( ) As String [JScript] public override function GetHttpVersion( ): String;

Description

[1965] GetLocalAddress

[C#] public override string GetLocalAddress( ); [C++] public: String* GetLocalAddress( ); [VB] Overrides Public Function GetLocalAddress( ) As String [JScript] public override function GetLocalAddress( ): String;

Description

[1966] GetLocalPort

[C#] public override int GetLocalPort( ); [C++] public: int GetLocalPort( ); [VB] Overrides Public Function GetLocalPort( ) As Integer [JScript] public override function GetLocalPort( ): int;

Description

[1967] GetPathInfo

[C#] public override string GetPathInfo( ); [C++] public: String* GetPathInfo( ); [VB] Overrides Public Function GetPathInfo( ) As String [JScript] public override function GetPathInfo( ): String;

Description

[1968] GetQueryString

[C#] public override string GetQueryString( ); [C++] public: String* GetQueryString( ); [VB] Overrides Public Function GetQueryString( ) As String [JScript] public override function GetQueryString( ): String;

Description

[1969] GetRawUrl

[C#] public override string GetRawUrl( ); [C++] public: String* GetRawUrl( ); [VB] Overrides Public Function GetRawUrl( ) As String [JScript] public override function GetRawUrl( ): String;

Description

[1970] GetRemoteAddress [C#] public override string GetRemoteAddress( ); [C++] public: String* GetRemoteAddress( ); [VB] Overrides Public Function GetRemoteAddress( ) As String [JScript] public override function GetRemoteAddress( ): String;

Description

[1971] GetRemotePort

[C#] public override int GetRemotePort( ); [C++] public: int GetRemotePort( ); [VB] Overrides Public Function GetRemotePort( ) As Integer [JScript] public override function GetRemotePort( ): int;

Description

[1972] GetServerVariable

[1973] [C#] public override string GetServerVariable(string name); [C++] public: String* GetServerVariable(String* name); [VB] Overrides Public Function GetServerVariable(ByVal name As String) As String [JScript] public override function GetServerVariable(name: String): String;

Description

[1974] GetUriPath

[C#] public override string GetUriPath( ); [C++] public: String* GetUriPath( ); [VB] Overrides Public Function GetUriPath( ) As String [JScript] public override function GetUriPath( ): String;

Description

[1975] GetUserToken

[C#] public override IntPtr GetUserToken( ); [C++] public: IntPtr GetUserToken( ); [VB] Overrides Public Function GetUserToken( ) As IntPtr [JScript] public override function GetUserToken( ): IntPtr;

Description

[1976] MapPath

[C#] public override string MapPath(string path); [C++] public: String* MapPath(String* path); [VB] Overrides Public Function MapPath(ByVal path As String) As String [JScript] public override function MapPath(path: String): String;

Description

[1977] SendKnownResponseHeader

[1978] [C#] public override void SendKnownResponseHeader(int index, string value); [C++] public: void SendKnownResponseHeader(int index, String* value); [VB] Overrides Public Sub SendKnownResponseHeader(ByVal index As Integer, ByVal value As String) [JScript] public override function SendKnownResponseHeader(index: int, value String);

Description

[1979] SendResponseFromFile

[1980] [C#] public override void SendResponseFromFile(IntPtr handle, long offset, long length); [C++] public: void SendResponseFromFile(IntPtr handle, _int64 offset, _int64 length); [VB] Overrides Public Sub SendResponseFromFile(ByVal handle As IntPtr, ByVal offset As Long, ByVal length As Long) [JScript] public override function SendResponseFromFile(handle: IntPtr, offset: long, length: long);

Description

[1981] SendResponseFromFile

[1982] [C#] public override void SendResponseFromFile(string filename, long offset, long length); [C++] public: void SendResponseFromFile(String* filename, _int64 offset, _int64 length); [VB] Overrides Public Sub SendResponseFromFile(ByVal filename As String, ByVal offset As Long, ByVal length As Long) [JScript] public override function SendResponseFromFile(filename: String, offset: long, length: long);

Description

[1983] SendResponseFromMemory

[1984] [C#] public override void SendResponseFromMemory(byte[ ] data, int length); [C++] public: void SendResponseFromMemory(unsigned char data _gc[ ], int length); [VB] Overrides Public Sub SendResponseFromMemory(ByVal data( ) As Byte, ByVal length As Integer) [JScript] public override function SendResponseFromMemory(data: Byte[ ], length: int);

Description

[1985] SendStatus

[1986] [C#] public override void SendStatus(int statusCode, string statusDescription); [C++] public: void SendStatus(int statusCode, String* statusDescription); [VB] Overrides Public Sub SendStatus(ByVal statusCode As Integer, ByVal statusDescription As String) [JScript] public override function SendStatus(statusCode: int, statusDescription String);

System.Web.Mail

[1987] Description

[1988] The System.Web.Mail namespace contains classes that enable you to construct and send an email attachment using the SMTP mail service built into Microsoft Windows 2000.

[1989] MailAttachment class (System.Web.Mail)

Description

[1990] Provides properties and methods to construct an email attachment.

[1991] Constructors:

[1992] MailAttachment

[1993] Example Syntax:

[C#] public MailAttachment(string filename); [C++] public: MailAttachment(String* filename); [VB] Public Sub New(ByVal filename As String) [JScript] public function MailAttachment(filename: String); Constructs an email attachment object.

Description

[1994] Constructs a MailAttachment object and specifies the file name of the attachment. Sets the System.Text.Encoding property to be UUEncode by default. Name of the attached file.

[1995] MailAttachment

[1996] Example Syntax:

[1997] [C#] public MailAttachment(string filename, MailEncoding encoding); [C++] public: MailAttachment(String* filename, MailEncoding encoding); [VB] Public Sub New(ByVal filename As String, ByVal encoding As MailEncoding) [JScript] public function MailAttachment(filename: String, encoding MailEncoding);

Description

[1998] Constructs an email attachment object and specifies the file name and encoding of the attachment. Name of the attached file. The type of System.Web.Mail.MailEncoding used by the attachment.

[1999] Properties:

[2000] Encoding

[C#] public MailEncoding Encoding {get;} [C++] public: _property MailEncoding get_Encoding( ); [VB] Public ReadOnly Property Encoding As MailEncoding [JScript] public function get Encoding( ): MailEncoding;

Description

[2001] Indicates the type of encoding used to encode the email attachment.

[2002] Filename

[C#] public string Filename {get;} [C++] public: _property String* get_Filename( ); [VB] Public ReadOnly Property Filename As String [JScript] public function get Filename( ): String;

Description

[2003] Indicates the name of the file to attach to the email.

[2004] Methods:

[2005] MailEncoding enumeration (System.Web.Mail)

[2006] ToString

Description

Provides enumered values for email encoding.

[2007] ToString

[C#] public const MailEncoding Base64; [C++] public: const MailEncoding Base64; [VB] Public Const Base64 As MailEncoding [JScript] public var Base64: MailEncoding;

Description

[2008] Specifies that the email message uses Base64 encoding.

[2009] ToString

[C#] public const MailEncoding UUEncode; [C++] public: const MailEncoding UUEncode; [VB] Public Const UUEncode As MailEncoding [JScript] public var UUEncode: MailEncoding;

Description

[2010] Specifies that the email message uses UUEncode encoding.

[2011] MailFormat enumeration (System.Web.Mail)

[2012] ToString

Description

[2013] Provides enumerated values for email format.

[2014] ToString

[C#] public const MailFormat Html; [C++] public: const MailFormat Html; [VB] Public Const Html As MailFormat [JScript] public var Html: MailFormat;

Description

[2015] Specifies that email format is HTML.

[2016] ToString

[C#] public const MailFormat Text; [C++] public: const MailFormat Text; [VB] Public Const Text As MailFormat [JScript] public var Text: MailFormat;

Description

[2017] Specifies that email format is plain text.

[2018] MailMessage class (System.Web.Mail)

[2019] ToString

Description

[2020] Provides properties and methods to construct an email message.

[2021] MailMessage

[2022] Example Syntax:

[2023] ToString

[C#] public MailMessage( ); [C++] public: MailMessage( ); [VB] Public Sub New( ) [JScript] public function MailMessage( );

[2024] Attachments

[2025] ToString

[C#] public IList Attachments {get;} [C++] public: _property IList* get_Attachments( ); [VB] Public ReadOnly Property Attachments As IList [JScript] public function get Attachments( ): IList;

Description

[2026] Specifies the list of attachments that is transmitted with the message.

[2027] Bcc

[2028] ToString

[C#] public string Bcc {get; set;} [C++] public: _property String* get_Bcc( );public: _property void set_Bcc(String*); [VB] Public Property Bcc As String [JScript] public function get Bcc( ): String;public function set Bcc(String);

Description

[2029] Gets or sets a semicolon-delimited list of email addresses that receive a Blind Carbon Copy (BCC) copy of the email message.

[2030] The primary and carbon copy System.Web.Mail.MailMessage.Cc recipients do not see addresses included in the Bcc field.

[2031] Body

[2032] ToString

[C#] public string Body {get; set;} [C++] public: _property String* get_Body( );public: _property void set_Body(String*); [VB] Public Property Body As String [JScript] public function get Body( ): String;public function set Body(String);

Description

[2033] Gets or sets the body of the email message.

[2034] BodyEncoding

[2035] ToString

[2036] [C#] public Encoding BodyEncoding {get; set;} [C++] public: _property Encoding* get_BodyEncoding( );public: _property void set_BodyEncoding(Encoding*); [VB] Public Property BodyEncoding As Encoding [JScript] public function get BodyEncoding( ): Encoding;public function set BodyEncoding(Encoding);

Description

[2037] Gets or sets the encoding type of the email body.

[2038] BodyFormat

[2039] ToString

[2040] [C#] public MailFormat BodyFormat {get; set;} [C++] public: _property MailFormat get_BodyFormat( );public: _property void set_BodyFormat(MailFormat); [VB] Public Property BodyFormat As MailFormat [JScript] public function get BodyFormat( ): MailFormat;public function set BodyFormat(MailFormat);

Description

[2041] Gets or sets the content type of the email body.

[2042] Cc

[2043] ToString

[C#] public string Cc {get; set;} [C++] public: _property String* get_Cc( );public: _property void set_Cc(String*); [VB] Public Property Cc As String [JScript] public function get Cc( ): String;public function set Cc(String);

Description

[2044] Gets or sets a semicolon-delimited list of email addresses that receive a Carbon Copy (CC) of the email message.

[2045] From

[2046] ToString

[C#] public string From {get; set;} [C++] public: _property String* get_From( );public: _property void set_From(String*); [VB] Public Property From As String [JScript] public function get From( ): String;public function set From(String);

Description

[2047] Gets or sets the email address of the sender.

[2048] Headers

[2049] ToString

[C#] public IDictionary Headers {get;} [C++] public: _property IDictionary* get_Headers( ); [VB] Public ReadOnly Property Headers As IDictionary [JScript] public function get Headers( ): IDictionary;

Description

[2050] Specifies the custom headers that are transmitted with the email message.

[2051] Priority

[2052] ToString

[2053] [C#] public MailPriority Priority {get; set;} [C++] public: _property MailPriority get_Priority( );public: _property void set_Priority(MailPriority); [VB] Public Property Priority As MailPriority [JScript] public function get Priority( ): MailPriority;public function set Priority(MailPriority);

Description

[2054] Gets or sets the priority of the email message.

[2055] Subject

[2056] ToString

[2057] [C#] public string Subject {get; set;} [C++] public: _property String* get_Subject( );public: _property void set_Subject(String*); [VB] Public Property Subject As String [JScript] public function get Subject( ): String;public function set Subject(String);

Description

[2058] Gets or sets the subject line of the email message.

[2059] To

[2060] ToString

[C#] public string To {get; set;} [C++] public: _property String* get_To( );public: _property void set_To(String*); [VB] Public Property To As String [JScript] public function get To( ): String;public function set To(String);

Description

[2061] Gets or sets the email address of the recipient.

[2062] UrlContentBase

[2063] ToString

[2064] [C#] public string UrlContentBase {get; set;} [C++] public: _property String* get_UrlContentBase( );public: _property void set_UrlContentBase(String*); [VB] Public Property UrlContentBase As String [JScript] public function get UrlContentBase( ): String;public function set UrlContentBase(String);

Description

[2065] Gets or sets the URL base of all relative URLs used within the HTML encoded body.

[2066] UrlContentLocation

[2067] ToString

[2068] [C#] public string UrlContentLocation {get; set;} [C++] public: _property String* get_UrlContentLocation( );public: _property void set_UrlContentLocation(String*); [VB] Public Property UrlContentLocation As String [JScript] public function get UrlContentLocation( ): String;public function set UrlContentLocation(String);

Description

[2069] MailPriority enumeration (System.Web.Mail)

[2070] ToString

Description

[2071] Provides enumerated values for email priority.

[2072] ToString

[C#] public const MailPriority High; [C++] public: const MailPriority High; [VB] Public Const High As MailPriority [JScript] public var High: MailPriority;

Description

[2073] Specifies that the email message has high priority.

[2074] ToString

[C#] public const MailPriority Low; [C++] public: const MailPriority Low; [VB] Public Const Low As MailPriority [JScript] public var Low: MailPriority;

Description

[2075] Specifies that the email message has low priority.

[2076] ToString

[C#] public const MailPriority Normal; [C++] public: const MailPriority Normal; [VB] Public Const Normal As MailPriority [JScript] public var Normal: MailPriority;

Description

[2077] Specifies that the email message has normal priority.

[2078] SmtpMail class (System.Web.Mail)

[2079] ToString

Description

[2080] Provides properties and methods to send an email attachment using the SMTP mail service built into Microsoft Windows 2000.

[2081] Mail is by default queued on a Windows 2000 system, ensuring that the calling program does not block network traffic.

[2082] SmtpMail

[2083] Example Syntax:

[2084] ToString

[C#] public SmtpMail( ); [C++] public: SmtpMail( ); [VB] Public Sub New( ) [JScript] public function SmtpMail( );

[2085] SmtpServer

[2086] ToString

[2087] [C#] public static string SmtpServer {get; set;} [C++] public: _property static String* get_SmtpServer( );public: _property static void set_SmtpServer(String*); [VB] Public Shared Property SmtpServer As String [JScript] public static function get SmtpServer( ): String;public static function set SmtpServer(String);

Description

[2088] Gets or sets the name of the SMTP mail server to use to send email messages.

[2089] Send

[C#] public static void Send(MailMessage message); [C++] public: static void Send(MailMessage* message); [VB] Public Shared Sub Send(ByVal message As MailMessage) [JScript] public static function Send(message: MailMessage);

Description

[2090] Sends a mail message using arguments supplied in the MailMessage properties. The System.Web.Mail.MailMessage object to send.

[2091] Send

[2092] [C#] public static void Send(string from, string to, string subject, string messageText); [C++] public: static void Send(String* from, String* to, String* subject, String* messageText); [VB] Public Shared Sub Send(ByVal from As String, ByVal to As String, ByVal subject As String, ByVal messageText As String) [JScript] public static function Send(from: String, to: String, subject: String, messageText: String); Sends a mail message.

Description

[2093] Sends a mail message using the supplied destination arguments. The address of the email's sender. The address of the email's recipient. The subject line of the email message.

System.Web.Security

[2094] Description

[2095] This namespace contains classes that are used to implement ASP.NET security in Web server applications.

[2096] DefaultAuthenticationEventArgs class (System.Web.Security)

Description

[2097] Provides a wrapper around the default authentication services. This class cannot be inherited.

[2098] For more information about handling events, see.

[2099] Constructors:

[2100] DefaultAuthenticationEventArgs

[2101] Example Syntax:

[2102] [C#] public DefaultAuthenticationEventArgs(HttpContext context); [C++] public: DefaultAuthenticationEventArgs(HttpContext* context); [VB] Public Sub New(ByVal context As HttpContext) [JScript] public function DefaultAuthenticationEventArgs(context: HttpContext);

Description

[2103] Initializes a new instance of the System.Web.Security.DefaultAuthenticationEventArgs class. The context for the event.

[2104] Properties:

[2105] Context

[C#] public HttpContext Context {get;} [C++] public: _property HttpContext* get_Context( ); [VB] Public ReadOnly Property Context As HttpContext [JScript] public function get Context( ): HttpContext;

Description

[2106] The HttpContext intrinsic provides access to Request, Response, and User objects.

[2107] Methods:

[2108] DefaultAuthenticationEventHandler delegate (System.Web.Security)

[2109] ToString

Description

[2110] Represents the method that handles the DefaultAuthentication_OnAuthenticate event of a DefaultAuthenticationModule. The object that raised the event. A DefaultAuthenticationEventArgs object that contains the event data.

[2111] When you create a System.Web.Security.DefaultAuthenticationEventHandler delegate, you identify the method to handle the event. To associate the event with your EventHandler, add an instance of the delegate to the event. The EventHandler is called whenever the event occurs, unless you remove the delegate. For more information about EventHandler delegates, see.

[2112] DefaultAuthenticationModule class (System.Web.Security)

[2113] ToString

Description

[2114] Insures that an Authentication object is present in the context. This class cannot be inherited.

[2115] DefaultAuthenticationModule

[2116] Example Syntax:

[2117] ToString

[C#] public DefaultAuthenticationModule( ); [C++] public: DefaultAuthenticationModule( ); [VB] Public Sub New( ) [JScript] public function DefaultAuthenticationModule( );

[2118] ToString

[C#] public event DefaultAuthenticationEventHandler Authenticate; [C++] public: _event DefaultAuthenticationEventHandler* Authenticate; [VB] Public Event Authenticate As DefaultAuthenticationEventHandler

Description

[2119] Defines the event raised by the DefaultAuthentication module. Used by the DefaultAuthentication_OnAuthenticate handler, if one exists.

[2120] When you create a System.Web.Security.DefaultAuthenticationModule delegate, you identify the method to handle the event. To associate the event with your EventHandler, add an instance of the delegate to the event. The EventHandler is called whenever the event occurs, unless you remove the delegate. For more information about EventHandler delegates, see.

[2121] Dispose

[C#] public void Dispose( ); [C++] public: _sealed void Dispose( ); [VB] NotOverridable Public Sub Dispose( ) [JScript] public function Dispose( );

Description

[2122] Called by the HTTP runtime to Dispose of the module (derived from IHttpModule).

[2123] Call System.Web.Security.DefaultAuthenticationModule.Dispose when you are finished using the System.Web.Security.DefaultAuthenticationModule. The System.Web.Security.DefaultAuthenticationModule.Dispose method leaves the System.Web.Security.DefaultAuthenticationModule in an unusable state. After calling System.Web.Security.DefaultAuthenticationModule.Dispose, you must release all references to the System.Web.Security.DefaultAuthenticationModule so the memory occupied can be reclaimed by garbage collection.

[2124] Init

[C#] public void Init(HttpApplication app); [C++] public: _sealed void Init(HttpApplication* app); [VB] NotOverridable Public Sub Init(ByVal app As HttpApplication) [JScript] public function Init(app: HttpApplication);

Description

[2125] Initializes the module. The HTTP application.

[2126] FileAuthorizationModule class (System.Web.Security)

[2127] ToString

Description

[2128] Verifies that the remote user has NT permissions to access the file requested. This class cannot be inherited.

[2129] This module provides authorization services against file system ACLs. When the Windows authentication module is being used for the application, this module ensures (if in the pipeline) that the requesting user is allowed read access to the resource before executing it.

[2130] FileAuthorizationModule

[2131] Example Syntax:

[2132] ToString

[C#] public FileAuthorizationModule( ); [C++] public: FileAuthorizationModule( ); [VB] Public Sub New( ) [JScript] public function FileAuthorizationModule( );

[2133] Dispose

[C#] public void Dispose( ); [C++] public: _sealed void Dispose( ); [VB] NotOverridable Public Sub Dispose( ) [JScript] public function Dispose( );

Description

[2134] Disposes of the module dervied from IHttpModule when called by the HttpRuntime.

[2135] Call System.Web.Security.FileAuthorizationModule.Dispose when you are finished using the System.Web.Security.FileAuthorizationModule. The System.Web.Security.FileAuthorizationModule.Dispose method leaves the System.Web.Security.FileAuthorizationModule in an unusable state. After calling System.Web.Security.FileAuthorizationModule.Dispose, you must release all references to the System.Web.Security.FileAuthorizationModule so the memory occupied can be reclaimed by garbage collection.

[2136] Init

[C#] public void Init(HttpApplication app); [C++] public: _sealed void Init(HttpApplication* app); [VB] NotOverridable Public Sub Init(ByVal app As HttpApplication) [JScript] public function Init(app: HttpApplication);

Description

[2137] Initializes the module. The HttpApplication module.

[2138] FormsAuthentication class (System.Web.Security)

[2139] ToString

Description

[2140] Provides static methods that supply helper utilities for manipulating authentication tickets. This class cannot be inherited.

[2141] FormsAuthentication

[2142] Example Syntax:

[2143] ToString

[C#] public FormsAuthentication( ); [C++] public: FormsAuthentication( ); [VB] Public Sub New( ) [JScript] public function FormsAuthentication( );

[2144] FormsCookieName

[2145] ToString

[C#] public static string FormsCookieName {get;} [C++] public: _property static String* get_FormsCookieName( ); [VB] Public Shared ReadOnly Property FormsCookieName As String [JScript] public static function get FormsCookieNameo: String;

Description

[2146] Returns the configured cookie name used for the current application.

[2147] Returns a String.

[2148] FormsCookiePath

[2149] ToString

[C#] public static string FormsCookiePath {get;} [C++] public: _property static String* get_FormsCookiePath( ); [VB] Public Shared ReadOnly Property FormsCookiePath As String [JScript] public static function get FormsCookiePath( ): String;

Description

[2150] Returns the configured cookie path used for the current application.

[2151] Authenticate

[2152] [C#] public static bool Authenticate(string name, string password); [C++] public: static bool Authenticate(String* name, String* password); [VB] Public Shared Function Authenticate(ByVal name As String, ByVal password As String) As Boolean [JScript] public static function Authenticate(name: String, password: String) Boolean;

Description

[2153] Attempts to validate the credentials against those contained in the configured credential store, given the supplied credentials.

Return Value. Returns true if the credentials are valid, otherwise returns false. The user name The user password.

[2154] Decrypt

[2155] [C#] public static FormsAuthenticationTicket Decrypt(string strEncrypted); [C++] public: static FormsAuthenticationTicket* Decrypt(String* strEncrypted); [VB] Public Shared Function Decrypt(ByVal strEncrypted As String) As FormsAuthenticationTicket [JScript] public static function Decrypt(strEncrypted: String) FormsAuthenticationTicket;

Description

[2156] Returns an instance of a FormsAuthenticationTicket class, given an encrypted authentication ticket obtained from an HTTP cookie.

Return Value. Returns a FormsAuthenticationTicket object.

[2157] Encrypt

[2158] [C#] public static string Encrypt(FormsAuthenticationTicket ticket); [C++] public: static String* Encrypt(FormsAuthenticationTicket* ticket); [VB] Public Shared Function Encrypt(ByVal ticket As FormsAuthenticationTicket) As String [JScript] public static function Encrypt(ticket: FormsAuthenticationTicket): String;

Description

[2159] Produces a string containing an encrypted authentication ticket suitable for use in an HTTP cookie, given a FormsAuthenticationTicket.

Return Value. Returns a String containing an encrypted authentication ticket. An authentication ticket class.

[2160] GetAuthCookie

[2161] [C#] public static HttpCookie GetAuthCookie(string userName, bool createPersistentCookie); [C++] public: static HttpCookie* GetAuthCookie(String* userName, bool createPersistentCookie); [VB] Public Shared Function GetAuthCookie(ByVal userName As String, ByVal createPersistentCookie As Boolean) As HttpCookie [JScript] public static function GetAuthCookie(userName: String, createPersistentCookie: Boolean): HttpCookie; Creates an authentication cookie for a given user name.

Description

[2162] Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response, so that an application can have more control over how the cookie is issued.

[2163] Return Value. Returns an HttpCookie. Name of the authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (a cookie that is saved across browser sessions) should be issued. Cookie path defaults to‘/’.

[2164] GetAuthCookie

[2165] [C#] public static HttpCookie GetAuthCookie(string userName, bool createPersistentCookie, string strCookiePath); [C++] public: static HttpCookie* GetAuthCookie(String* userName, bool createPersistentCookie, String* strCookiePath); [VB] Public Shared Function GetAuthCookie(ByVal userName As String, ByVal createPersistentCookie As Boolean, ByVal strCookiePath As String) As HttpCookie [JScript] public static function GetAuthCookie(userName: String, createPersistentCookie: Boolean, strCookiePath: String): HttpCookie;

Description

[2166] Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response, so that an application can have more control over how the cookie is issued.

Return Value. Returns an HttpCookie. Name of the authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (a cookie that is saved across browser sessions) should be issued. Specifies cookie path.

[2167] GetRedirectUrl

[2168] [C#] public static string GetRedirectUrl(string userName, bool createPersistentCookie); [C++] public: static String* GetRedirectUrl(String* userName, bool createPersistentCookie); [VB] Public Shared Function GetRedirectUrl(ByVal userName As String, ByVal createPersistentCookie As Boolean) As String [JScript] public static function GetRedirectUrl(userName: String, createPersistentCookie: Boolean): String;

Description

[2169] Returns the redirect URL for the original request that caused the redirect to the logon page.

Return Value. Returns a String.

[2170] If there is no original URL, Default.aspx is used. If the redirect URL specifies a different server, this method also returns the authentication ticket as part of the query string. This method can be used by applications that need to do the redirect themselves instead of using RedirectFromLoginPage. Name of the authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (a cookie that is saved across browser sessions) should be issued. Cookie path defaults to‘/’.

[2171] HashPasswordForStoringInConfigFile

[2172] [C#] public static string HashPasswordForStoringInConfigFile(string password, string passwordFormat); [C++] public: static String* HashPasswordForStoringInConfigFile(String* password, String* passwordFormat); [VB] Public Shared Function HashPasswordForStoringInConfigFile(ByVal password As String, ByVal passwordFormat As String) As String [JScript] public static function HashPasswordForStoringInConfigFile(password: String, passwordFormat: String): String;

Description

[2173] Given a password and a string identifying the hash type, this routine produces a hash password suitable for storing in a configuration file.

Return Value. Returns a String containing a hashed password.

[2174] Password algorithms supported are SHA1 and MD5. The pasword to hash. The hash algorithm to use. Choices are “sha1” or “md5”.

[2175] Initialize

[C#] public static void Initialize( ); [C++] public: static void Initialize( ); [VB] Public Shared Sub Initialize( ) [JScript] public static function Initialize( );

Description

[2176] Initializes FormsAuthentication by reading the configuration and getting the cookie values and encryption keys for the given application.

[2177] RedirectFromLoginPage

[2178] [C#] public static void RedirectFromLoginPage(string userName, bool createPersistentCookie); [C++] public: static void RedirectFromLoginPage(String* userName, bool createPersistentCookie); [VB] Public Shared Sub RedirectFromLoginPage(ByVal userName As String, ByVal createPersistentCookie As Boolean) [JScript] public static function RedirectFromLoginPage(userName: String, createPersistentCookie: Boolean); Redirects an authenticated user back to the originally requested URL.

Description

[2179] Redirects an authenticated user back to the originally requested URL.

[2180] Redirects, based on the contents of the ReturnURL key in the query string, or redirects to Default.aspx if the return key does not exist. It issues an authentication ticket and does a SetForms with the ticket, using the appropriately configured cookie name for the application as part of the redirect response. Name of the user for cookie authentication purposes. This does not need to map to an account name and will be used by URL Authorization. Specifies whether or not a durable cookie (one that is saved across browser sessions) should be issued.

[2181] RedirectFromLoginPage

[2182] [C#] public static void RedirectFromLoginPage(string userName, bool createPersistentCookie, string strCookiePath); [C++] public: static void RedirectFromLoginPage(String* userName, bool createPersistentCookie, String* strCookiePath); [VB] Public Shared Sub RedirectFromLoginPage(ByVal userName As String, ByVal createPersistentCookie As Boolean, ByVal strCookiePath As String) [JScript] public static function RedirectFromLoginPage(userName: String, createPersistentCookie: Boolean, strCookiePath: String);

Description

[2183] Redirects an authenticated user back to the originally requested URL.

[2184] Redirects, based on the contents of the ReturnURL key in the query string, or redirects to Default.aspx if the return key does not exist. It issues an authentication ticket and does a SetForms with the ticket, using the appropriately configured cookie name for the application as part of the redirect response. Name of the user for cookie authentication purposes. This does not need to map to an account name and will be used by URL Authorization. Specifies whether or not a durable cookie (one that is saved across browser sessions) should be issued. Specifies cookie path.

[2185] RenewTicketIfOld

[2186] [C#] public static FormsAuthenticationTicket RenewTicketIfOld(FormsAuthenticationTicket tOld); [C++] public: static FormsAuthenticationTicket* RenewTicketIfOld(FormsAuthenticationTicket* tOld); [VB] Public Shared Function RenewTicketIfOld(ByVal tOld As FormsAuthenticationTicket) As FormsAuthenticationTicket [JScript] public static function RenewTicketIfOld(tOld: FormsAuthenticationTicket): FormsAuthenticationTicket;

Description

[2187] Conditionally updates the sliding expiration on a FormsAuthenticationTicket.

Return Value. Returns the updated FormsAuthenticationTicket.

[2188] The ticket is updated with the IssueDate set to the current time and the expiration based on the difference between the previous expiration time and issue time. The test used to determine whether the ticket should be updated is (DateTime.Now â“ IssueDate)>(Expiration â“ DateTime.Now).

[2189] SetAuthCookie

[2190] [C#] public static void SetAuthCookie(string userName, bool createPersistentCookie); [C++] public: static void SetAuthCookie(String* userName, bool createPersistentCookie); [VB] Public Shared Sub SetAuthCookie(ByVal userName As String, ByVal createPersistentCookie As Boolean) [JScript] public static function SetAuthCookie(userName: String, createPersistentCookie: Boolean); Creates an authentication ticket and attaches it to the cookie's collection of the outgoing response. It does not perform a redirect.

Description

[2191] Creates an authentication ticket for the given userName and createPersistentCookie and attaches it to the cookie's collection of the outgoing response. It does not perform a redirect.

[2192] This has the effect of creating an authenticated user. Applications can use this when they intend to manually redirect, or if they do not want to redirect. For example, you can use this for an embedded logon area on a page. The name of an authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (one that is saved across browser sessions) should be issued.

[2193] SetAuthCookie

[2194] [C#] public static void SetAuthCookie(string userName, bool createPersistentCookie, string strCookiePath); [C++] public: static void SetAuthCookie(String* userName, bool createPersistentCookie, String* strCookiePath); [VB] Public Shared Sub SetAuthCookie(ByVal userName As String, ByVal createPersistentCookie As Boolean, ByVal strCookiePath As String) [JScript] public static function SetAuthCookie(userName: String, createPersistentCookie: Boolean, strCookiePath: String);

Description

[2195] Creates an authentication ticket for the given userName,createPersistentCookie, and strCookiePath and attaches it to the cookie's collection of the outgoing response. It does not perform a redirect.

[2196] This has the effect of creating an authenticated user. Applications can use this when they intend to manually redirect, or if they do not want to redirect. For example, you can use this for an embedded logon area on a page. The name of an authenticated user. This does not have to map to a Windows account. Specifies whether or not a durable cookie (one that is saved across browser sessions) should be issued. Specifies cookie path.

[2197] SignOut

[C#] public static void SignOut( ); [C++] public: static void SignOut( ); [VB] Public Shared Sub SignOut( ) [JScript] public static function SignOut( );

Description

[2198] Removes the authentication ticket by doing a SetForms with an empty value, given an authenticated user. This removes either durable or session cookies.

[2199] FormsAuthenticationEventArgs class (System.Web.Security)

[2200] ToString

Description

[2201] Provides data for the FormsAuthentication_OnAuthenticate event. This class cannot be inherited.

[2202] For more information about handling events, see.

[2203] FormsAuthenticationEventArgs

[2204] Example Syntax:

[2205] ToString

[2206] [C#] public FormsAuthenticationEventArgs(HttpContext context); [C++] public: FormsAuthenticationEventArgs(HttpContext* context); [VB] Public Sub New(ByVal context As HttpContext) [JScript] public function FormsAuthenticationEventArgs(context: HttpContext);

Description

[2207] Initializes a new instance of the System.Web.Security.FormsAuthenticationEventArgs class.

[2208] The following table shows initial property values for an instance of System.Web.Security.FormsAuthenticationEventArgs. The context for the event.

[2209] Context

[2210] ToString

[C#] public HttpContext Context {get;} [C++] public: _property HttpContext* get_Context( ); [VB] Public ReadOnly Property Context As HttpContext [JScript] public function get Context( ): HttpContext;

Description

[2211] Provides access to Request, Response, and User objects. This is the HttpContext intrinsic.

[2212] See the ASP.NET HttpRuntime documentation for more information.

[2213] User

[2214] ToString

[2215] [C#] public IPrincipal User {get; set;} [C++] public: _property IPrincipal* get_User( );public: _property void set_User(IPrincipal*); [VB] Public Property User As IPrincipal [JScript] public function get User( ): IPrincipal;public function set User(IPrincipal);

Description

[2216] Indicates the IPrincipal object to be associated with the request.

[2217] The user object will be attached to the context. If User is non null and Context.User is null, the FormsAuthenticationModule will initialize Context.User with FormsAuthenticationEventArgs.User.

[2218] FormsAuthenticationEventHandler delegate (System.Web.Security)

[2219] ToString

Description

[2220] Represents the method that will handle the FormsAuthentication event of a FormsAuthenticationModule. The source of the event. A System.Web.Security.FormsAuthenticationEventArgs that contains the event data.

[2221] When you create a System.Web.Security.FormsAuthenticationEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see This delegate defines the signature for the FormsAuthentication_OnAuthenticate event handler.

[2222] FormsAuthenticationModule class (System.Web.Security)

[2223] ToString

Description

[2224] Enables ASP.NET applications to use forms authentication. This class cannot be inherited.

[2225] FormsAuthenticationModule

[2226] Example Syntax:

[2227] ToString

[C#] public FormsAuthenticationModule( ); [C++] public: FormsAuthenticationModule( ); [VB] Public Sub New( ) [JScript] public function FormsAuthenticationModule( );

[2228] ToString

[C#] public event FormsAuthenticationEventHandler Authenticate; [C++] public: _event FormsAuthenticationEventHandler* Authenticate; [VB] Public Event Authenticate As FormsAuthenticationEventHandler

Description

[2229] Defines the event raised during authentication. This is a Global.asax event that must be named FormsAuthentication_OnAuthenticate. You can use this event to customize cookie authentication.

[2230] For more information about handling events, see.

[2231] Dispose

[C#] public void Dispose( ); [C++] public: _sealed void Dispose( ); [VB] NotOverridable Public Sub Dispose( ) [JScript] public function Dispose( );

Description

[2232] Disposes of the module derived from IHttpModule when called by the HttpRuntime.

[2233] Call System.Web.Security.FormsAuthenticationModule.Dispose when you are finished using the System.Web.Security.FormsAuthenticationModule. The System.Web.Security.FormsAuthenticationModule.Dispose method leaves the System.Web.Security.FormsAuthenticationModule in an unusable state. After calling System.Web.Security.FormsAuthenticationModule.Dispose, you must release all references to the System.Web.Security.FormsAuthenticationModule so the memory it was occupying can be reclaimed by garbage collection.

[2234] Init

[C#] public void Init(HttpApplication app); [C++] public: _sealed void Init(HttpApplication* app); [VB] NotOverridable Public Sub Init(ByVal app As HttpApplication) [JScript] public function Init(app: HttpApplication);

Description

[2235] Initializes the module derived from IHttpModule when called by the HttpRuntime. The HttpApplication module.

[2236] OnEnter

[2237] [C#] public void OnEnter(object source, EventArgs eventArgs); [C++] public: void OnEnter(Object* source, EventArgs* eventArgs); [VB] Public Sub OnEnter(ByVal source As Object, ByVal eventArgs As EventArgs) [JScript] public function OnEnter(source: Object, eventArgs: EventArgs);

Description

[2238] Called by the HttpRuntime. The source of the event. A System.Web.Security.FormsAuthenticationEventArgsthat contains the event data.

[2239] OnLeave

[2240] [C#] public void OnLeave(object source, EventArgs eventArgs); [C++] public: void OnLeave(Object* source, EventArgs* eventArgs); [VB] Public Sub OnLeave(ByVal source As Object, ByVal eventArgs As EventArgs) [JScript] public function OnLeave(source: Object, eventArgs: EventArgs);

Description

[2241] Called by the HttpRuntime. The source of the event. A System.Web.Security.FormsAuthenticationEventArgsthat contains the event data.

[2242] FormsAuthenticationTicket class (System.Web.Security)

[2243] ToString

Description

[2244] Provides the information represented in an authentication cookie as used by FormsAuthenticationModule. This class cannot be inherited.

[2245] For more information about using attributes, see.

[2246] FormsAuthenticationTicket

[2247] Example Syntax:

[2248] ToString

[2249] [C#] public FormsAuthenticationTicket(string name, bool isPersistent, int timeout); [C++] public: FormsAuthenticationTicket(String* name, bool isPersistent, int timeout); [VB] Public Sub New(ByVal name As String, ByVal isPersistent As Boolean, ByVal timeout As Integer) [JScript] public function FormsAuthenticationTicket(name: String, isPersistent: Boolean, timeout: int);

Description

[2250] Creates a FormsAuthenticationTicket instance with the specified name and cookie durability, and default values for the other settings (version set internally, dates set to current date, and expiration determined on durability of cookie).

[2251] The default settings include version number, dates that are set to the current date, and expiration as determined by the durability setting. User name associated with the ticket. If true, use a persistent cookie. Specifies the time in minutes (as an integer) for which the authentication ticket is valid.

[2252] FormsAuthenticationTicket

[2253] Example Syntax:

[2254] ToString

[2255] [C#] public FormsAuthenticationTicket(int version, string name, DateTime issueDate, DateTime expiration, bool isPersistent, string userData); [C++] public: FormsAuthenticationTicket(int version, String* name, DateTime issueDate, DateTime expiration, bool isPersistent, String* userData); [VB] Public Sub New(ByVal version As Integer, ByVal name As String, ByVal issueDate As DateTime, ByVal expiration As DateTime, ByVal isPersistent As Boolean, ByVal userData As String) [JScript] public function FormsAuthenticationTicket(version: int, name: String, issueDate: DateTime, expiration: DateTime, isPersistent: Boolean, userData: String); Creates a FormsAuthenticationTicket instance.

Description

[2256] Creates a FormsAuthenticationTicket instance with explicit values. The version number. User name associated with the ticket. Time at which the cookie was issued. Set an expiration date for the cookie. True if the cookie is persistent. User-defined data to be stored in the cookie.

[2257] FormsAuthenticationTicket

[2258] Example Syntax:

[2259] ToString

[2260] [C#] public FormsAuthenticationTicket(int version, string name, DateTime issueDate, DateTime expiration, bool isPersistent, string userData, string cookiePath); [C++] public: FormsAuthenticationTicket(int version, String* name, DateTime issueDate, DateTime expiration, bool isPersistent, String* userData, String* cookiePath); [VB] Public Sub New(ByVal version As Integer, ByVal name As String, ByVal issueDate As DateTime, ByVal expiration As DateTime, ByVal isPersistent As Boolean, ByVal userData As String, ByVal cookiepath As String) [JScript] public function FormsAuthenticationTicket(version: int, name: String, issueDate: DateTime, expiration: DateTime, isPersistent: Boolean, userData String, cookiePath: String);

Description

[2261] Creates a FormsAuthenticationTicket instance with explicit values. The version number. User name associated with the ticket. Time at which the cookie was issued. Set an expiration date for the cookie. True if the cookie is persistent. User-defined data to be stored in the cookie. THe path for the cookie.

[2262] CookiePath

[2263] ToString

[C#] public string CookiePath {get;} [C++] public: _property String* get_CookiePath( ); [VB] Public ReadOnly Property CookiePath As String [JScript] public function get CookiePath( ): String;

Description

[2264] Returns the Path for which the cookie was issued.

[2265] This is used when the cookie is refreshed.

[2266] Expiration

[2267] ToString

[C#] public DateTime Expiration {get;} [C++] public: _property DateTime get_Expiration( ); [VB] Public ReadOnly Property Expiration As DateTime [JScript] public function get Expiration( ): DateTime;

Description

[2268] Returns the date/time at which the cookie expires.

[2269] For durable cookies, this should be the maximum value. For session scoped cookies, this should be set to the time the cookie was issued. This can be used by custom application logic to implement more-advanced expiration semantics.

[2270] Expired

[2271] ToString

[C#] public bool Expired {get;} [C++] public: _property bool get_Expired( ); [VB] Public ReadOnly Property Expired As Boolean [JScript] public function get Expired( ): Boolean;

Description

[2272] Returns True if the cookie has expired.

[2273] IsPersistent

[2274] ToString

[C#] public bool IsPersistent {get;} [C++] public: _property bool get_IsPersistent( ); [VB] Public ReadOnly Property IsPersistent As Boolean [JScript] public function get IsPersistent( ): Boolean;

Description

[2275] Returns True if a durable cookie was issued. Otherwise, the authentication cookie is scoped to the browser lifetime.

[2276] IssueDate

[2277] ToString

[C#] public DateTime IssueDate {get;} [C++] public: _property DateTime get_IssueDate( ); [VB] Public ReadOnly Property IssueDate As DateTime [JScript] public function get IssueDate( ): DateTime;

Description

[2278] Returns the date/time at which the cookie was originally issued. This can be used for custom expiration schemes.

[2279] Name

[2280] ToString

[C#] public string Name {get;} [C++] public: _property String* get_Name( ); [VB] Public ReadOnly Property Name As String [JScript] public function get Name( ): String;

Description

[2281] Returns the user name associated with the authentication cookie.

[2282] This string is used for authorization purposes.

[2283] UserData

[2284] ToString

[C#] public string UserData {get;} [C++] public: _property String* get_UserData( ); [VB] Public ReadOnly Property UserData As String [JScript] public function get UserData( ): String;

Description

[2285] Returns an application-defined string that might have been stored in the cookie.

[2286] This field will be empty (“ ”) if no application-defined data was provided.

[2287] Version

[2288] ToString

[C#] public int Version {get;} [C++] public: _property int get_Version( ); [VB] Public ReadOnly Property Version As Integer [JScript] public function get Version( ): int;

Description

[2289] Returns a byte version number for future use.

[2290] The current version identifier is 1.

[2291] FormsIdentity class (System.Web.Security)

[2292] ToString

Description

[2293] Provides an IIdentity-derived class to be used by FormsAuthenticationModule. It provides a way for an application to access the cookie authentication ticket. This class cannot be inherited.

[2294] FormsIdentity

[2295] Example Syntax:

[2296] ToString

[2297] [C#] public FormsIdentity(FormsAuthenticationTicket ticket); [C++] public: FormsIdentity(FormsAuthenticationTicket* ticket); [VB] Public Sub New(ByVal ticket As FormsAuthenticationTicket) [JScript] public function FormsIdentity(ticket: FormsAuthenticationTicket);

Description

[2298] Initializes a new instance of the System.Web.Security.FormsIdentity class. The authentication ticket upon which this identity is based.

[2299] AuthenticationType

[2300] ToString

[C#] public string AuthenticationType {get;} [C++] public: property String* get AuthenticationType( ); [VB] Public ReadOnly Property AuthenticationType As String [JScript] public function get AuthenticationType( ): String;

Description

[2301] The type of the identity (in this case, “Forms”).

[2302] IsAuthenticated

[2303] ToString

[C#] public bool IsAuthenticated {get;} [C++] public: property bool get IsAuthenticated( ); [VB] Public ReadOnly Property IsAuthenticated As Boolean [JScript] public function get IsAuthenticated( ): Boolean;

Description

[2304] Indicates whether authentication took place.

[2305] Name

[2306] ToString

[C#] public string Name {get;} [C++] public: _property String* get_Name( ); [VB] Public ReadOnly Property Name As String [JScript] public function get Name( ): String;

Description

[2307] The name of the identity (in this case, the user name).

[2308] Ticket

[2309] ToString

[2310] [C#] public FormsAuthenticationTicket Ticket {get;} [C++] public: _property FormsAuthenticationTicket* get_Ticket( ); [VB] Public ReadOnly Property Ticket As FormsAuthenticationTicket [JScript] public function get Ticket( ): FormsAuthenticationTicket;

Description

[2311] Returns the FormsAuthenticationTicket associated with the current request.

[2312] PassportAuthenticationEventArgs class (System.Web.Security)

[2313] ToString

Description

[2314] The event argument passed to the PassportAuthentication_OnAuthenticate event by the PassportAuthentication module. Since there is already an identity at this point, this is useful mainly for attaching a custom IPrincipal object to the context using the supplied identity.

[2315] For more information about handling events, see.

[2316] PassportAuthenticationEventArgs

[2317] Example Syntax:

[2318] ToString

[2319] [C#] public PassportAuthenticationEventArgs(PassportIdentity identity, HttpContext context); [C++] public: PassportAuthenticationEventArgs(PassportIdentity* identity, HttpContext* context); [VB] Public Sub New(ByVal identity As PassportIdentity, ByVal context As HttpContext) [JScript] public function PassportAuthenticationEventArgs(identity: PassportIdentity, context: HttpContext);

Description

[2320] Initializes a new instance of the System.Web.Security.PassportAuthenticationEventArgs class. The identity object The context for the event.

[2321] Context

[2322] ToString

[C#] public HttpContext Context {get;} [C++] public: _property HttpContext* get_Context( ); [VB] Public ReadOnly Property Context As HttpContext [JScript] public function get Context( ): HttpContext;

Description

[2323] The HttpContext intrinsic provides access to Request, Response, and User objects.

[2324] Identity

[2325] ToString

[C#] public PassportIdentity Identity {get;} [C++] public: _property PassportIdentity* get_Identity( ); [VB] Public ReadOnly Property Identity As PassportIdentity [JScript] public function get Identity( ): PassportIdentity;

Description

[2326] An authenticated Passport identity.

[2327] User

[2328] ToString

[2329] [C#] public IPrincipal User {get; set;} [C++] public: _property IPrincipal* get_User( );public: _property void set_User(IPrincipal*); [VB] Public Property User As IPrincipal [JScript] public function get User( ): IPrincipal;public function set User(IPrincipal);

Description

[2330] Associates an IPrincipal object with the request.

[2331] The User object should be attached to the context. If User is non-null and Context.User is null, the PassportAuthenticationModule will initialize Context.User with PassportAuthenticationEventArgs.User.

[2332] PassportAuthenticationEventHandler delegate (System.Web.Security)

[2333] ToString

Description

[2334] Represents the method that handles the PassportAuthentication_OnAuthenticate event of a PassportAuthenticationModule. The object that raised the event. A PassportAuthenticationEventArgs object that contains the event data.

[2335] When you create a System.Web.Security.PassportAuthenticationEventHandler delegate, you identify the method to handle the event. To associate the event with your EventHandler, add an instance of the delegate to the event. The EventHandler is called whenever the event occurs, unless you remove the delegate. For more information about EventHandler delegates, see.

[2336] PassportAuthenticationModule class (System.Web.Security)

[2337] ToString

Description

[2338] Provides a wrapper around PassportAuthentication services. This class cannot be inherited.

[2339] Installation of the Passport SDK is still required, as is registration of the site with the Passport authority. The PassportAuthentication_OnAuthenticate event is raised for applications that are designed to attach a custom IPrincipal object to the context. The Passport service itself does the authentication, so that cannot be overridden.

[2340] PassportAuthenticationModule

[2341] Example Syntax:

[2342] ToString

[C#] public PassportAuthenticationModule( ); [C++] public: PassportAuthenticationModule( ); [VB] Public Sub New( ) [JScript] public function PassportAuthenticationModule( );

[2343] ToString

[C#] public event PassportAuthenticationEventHandler Authenticate; [C++] public: _event PassportAuthenticationEventHandler* Authenticate; [VB] Public Event Authenticate As PassportAuthenticationEventHandler

Description

[2344] Raised during authentication. This is a Global.asax event that must be named PassportAuthentication_OnAuthenticate event.

[2345] Advanced users use this event to attach a custom IPrinciple object to the context.

[2346] Dispose

[C#] public void Dispose( ); [C++] public: _sealed void Dispose( ); [VB] NotOverridable Public Sub Dispose( ) [JScript] public function Dispose( );

Description

[2347] Disposes of the module derived from IHttpModule when called by the HttpRuntime.

[2348] Call System.Web.Security.PassportAuthenticationModule.Dispose when you are finished using the System.Web.Security.PassportAuthenticationModule. The System.Web.Security.PassportAuthenticationModule.Dispose method leaves the System.Web.Security.PassportAuthenticationModule in an unusable state. After calling System.Web.Security.PassportAuthenticationModule.Dispose, you must release all references to the System.Web.Security.PassportAuthenticationModule so the memory it occupied can be reclaimed by garbage collection.

[2349] Init

[C#] public void Init(HttpApplication app); [C++] public: _sealed void Init(HttpApplication* app); [VB] NotOverridable Public Sub Init(ByVal app As HttpApplication) [JScript] public function Init(app: HttpApplication);

Description

[2350] Initializes the module (derived from IHttpModule) when called by the HttpRuntime. The HttpApplication module

[2351] PassportIdentity class (System.Web.Security)

[2352] ToString

Description

[2353] Provides access to the Passport profile information contained in the Passport profile cookies. This is an IIdentity-derived class. This class cannot be inherited.

[2354] ASP.NET Beta 2 requires the 1.4 version of the Passport SDK.

[2355] PassportIdentity

[2356] Example Syntax:

[2357] ToString

[C#] public PassportIdentity( ); [C++] public: PassportIdentity( ); [VB] Public Sub New( ) [JScript] public function PassportIdentity( );

Description

[2358] Creates a new instance of the PassportIdentity object.

[2359] AuthenticationType

[2360] ToString

[C#] public string AuthenticationType {get;} [C++] public: _property String* get_AuthenticationType( ); [VB] Public ReadOnly Property AuthenticationType As String [JScript] public function get AuthenticationType( ): String;

Description

[2361] The type of the identity. In this case, Passport.

[2362] See the Passport SDK documentation for more information about PassportIdentity.AuthenticationType.

[2363] Error

[2364] ToString

[C#] public int Error {get;} [C++] public: _property int get_Error( ); [VB] Public ReadOnly Property Error As Integer [JScript] public function get Error( ): int;

Description

[2365] Returns an error state associated with the current Passport ticket. For more information, see the error property in the Passport documentation.

[2366] GetFromNetworkServer

[2367] ToString

[C#] public bool GetFromNetworkServer {get;} [C++] public: _property bool get_GetFromNetworkServer( ); [VB] Public ReadOnly Property GetFromNetworkServer As Boolean [JScript] public function get GetFromNetworkServer( ): Boolean;

Description

[2368] Returns true if a connection is coming back from the Passport server (logon, update, or registration) and if the Passport data contained on the query string is valid.

[2369] HasSavedPassword

[2370] ToString

[C#] public bool HasSavedPassword {get;} [C++] public: property bool get HasSavedPassword( ); [VB] Public ReadOnly Property HasSavedPassword As Boolean [JScript] public function get HasSavedPassword( ): Boolean;

Description

[2371] Returns true if the Passport member's ticket indicates that the password was saved on the Passport logon page the last time the ticket was refreshed.

[2372] For more information, see the Passport SDK documentation.

[2373] HasTicket

[2374] ToString

[C#] public bool HasTicket {get;} [C++] public: _property bool get_HasTicket( ); [VB] Public ReadOnly Property HasTicket As Boolean [JScript] public function get HasTicketo: Boolean;

Description

[2375] Returns true if there is a Passport ticket as a cookie on the query string.

[2376] For more information, see the Passport SDK documentation.

[2377] IsAuthenticated

[2378] ToString

[C#] public bool IsAuthenticated {get;} [C++] public: _property bool get_IsAuthenticated( ); [VB] Public ReadOnly Property IsAuthenticated As Boolean [JScript] public function get IsAuthenticated( ): Boolean;

Description

[2379] Returns true if the user is authenticated by a Passport authority.

[2380] For more information, see the Passport SDK documentation.

[2381] Item

[2382] ToString

[2383] [C#] public string this[string strProfileName] {get;} [C++] public: _property String* get_Item(String* strProfileName); [VB] Public Default ReadOnly Property Item(ByVal strProfileName As String) As String [JScript] returnValue=PassportIdentityObject.Item(strProfileName);

Description

[2384] Acceses Passport profile attributes. Calling this property is the equivalent of calling GetProfileObject or SetProfileObject.

[2385] For more information, see the Passport SDK documentation. The Passport profile attribute to query.

[2386] Name

[2387] ToString

[C#] public string Name {get;} [C++] public: _property String* get_Name( ); [VB] Public ReadOnly Property Name As String [JScript] public function get Name( ): String;

Description

[2388] Consists of the name of the identity. In this case, it is the value of the Passport PUID.

[2389] For more information, see the Passport SDK documentation.

[2390] TicketAge

[2391] ToString

[C#] public int TicketAge {get;} [C++] public: _property int get_TicketAge( ); [VB] Public ReadOnly Property TicketAge As Integer [JScript] public function get TicketAge( ): int;

Description

[2392] Consists of the time, in seconds, since the last ticket was issued or refreshed.

[2393] For more information, see the Passport SDK documentation.

[2394] TimeSinceSignIn

[2395] ToString

[C#] public int TimeSinceSignIn {get;} [C++] public: _property int get_TimeSinceSignIn( ); [VB] Public ReadOnly Property TimeSinceSignIn As Integer [JScript] public function get TimeSinceSignIn( ): int;

Description

[2396] Consists of the time, in seconds, since a member's log on to the Passport logon server.

[2397] For more information, see the Passport SDK documentation.

[2398] AuthUrl

[C#] public string AuthUrl( ); [C++] public: String* AuthUrl( ); [VB] Public Function AuthUrl( ) As String [JScript] public function AuthUrl( ): String; There are two overloads for this method.

Description

[2399] Returns a string containing the login server URL for a member, along with the optional information sent to the login server in the query string.

[2400] AuthUrl

[2401] [C#] public string AuthUrl(string strReturnUrl, int iTimeWindow, bool fForceLogin, string strCoBrandedArgs, int iLangID, string strNameSpace, int iKPP, bool bUseSecureAuth); [C++] public: String* AuthUrl(String* strReturnUrl, int iTimeWindow, bool fForceLogin, String* strCoBrandedArgs, int iLangID, String* strNameSpace, int iKPP, bool bUseSecureAuth); [VB] Public Function AuthUrl(ByVal strReturnUrl As String, ByVal iTimeWindow As Integer, ByVal fForceLogin As Boolean, ByVal strCoBrandedArgs As String, ByVal iLangID As Integer, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal bUseSecureAuth As Boolean) As String [JScript] public function AuthUrl(strReturnUrl: String, iTimeWindow: int, fForceLogin: Boolean, strCoBrandedArgs: String, iLangID: int, strNameSpace: String, iKPP: int, bUseSecureAuth: Boolean): String;

Description

[2402] Similar to AuthUrl( ). Returns the authentication server URL for a member.

[2403] For more information about the parameters for this method, see the Passport SDK documentation. Sets the URL of the location that the Login server should redirect to after sign-in is complete. Specifies the interval during which members must have last signed in. Determines how the iTimeWindow will be used. Specifies variables to be appended to the URL of the Co-branding Template script page that was specified at initial participant registration. Specifies the language in which the required domain authority page should be displayed. Specifies the domain in which the Passport should be created. Specifies data collection policies for purposes of COPPA compliance. Declares whether the actual sign-in UI should be served HTTPS from the Passport domain authority.

[2404] AuthUrl

[2405] [C#] public string AuthUrl(string strReturnUrl, int iTimeWindow, int iForceLogin, string strCoBrandedArgs, int iLangID, string strNameSpace, int iKPP, int iUseSecureAuth); [C++] public: String* AuthUrl(String* strReturnUrl, int iTimeWindow, int iForceLogin, String* strCoBrandedArgs, int iLangID, String* strNameSpace, int iKPP, int iUseSecureAuth); [VB] Public Function AuthUrl(ByVal strReturnUrl As String, ByVal iTimeWindow As Integer, ByVal iForceLogin As Integer, ByVal strCoBrandedArgs As String, ByVal iLangID As Integer, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal iUseSecureAuth As Integer) As String [JScript] public function AuthUrl(strReturnUrl: String, iTimeWindow: int, iForceLogin: int, strCoBrandedArgs: String, iLangID: int, strNameSpace String, iKPP: int, iUseSecureAuth: int): String;

Description

[2406] AuthUrl2

[2407] [C#] public string AuthUrl2( ); [C++] public: String* AuthUrl2( ); [VB] Public Function AuthUrl2( ) As String [JScript] public function AuthUrl2( ): String; Retrieves a String containing the logon server URL for a member, as well as the optional information sent to the logon server in the query string.

Description

[2408] Retrieves a String containing the logon server URL for a member, as well as the optional information sent to the logon server in the query string.

Return Value. The logon server URL for a member, as well as the optional information sent to the logon server in the query string.

[2409] This URL can be used to generate a link for a member who has not signed in previously or who has an expired ticket. For more details, see IPassportManager2::Authaurl2 in the Passport SDK documentation.

[2410] AuthUrl2

[2411] [C#] public string AuthUrl2(string strReturnUrl, int iTimeWindow, bool fForceLogin, string strCoBrandedArgs, int iLangID, string strNameSpace, int iKPP, bool bUseSecureAuth); [C++] public: String* AuthUrl2(String* strReturnUrl, int iTimeWindow, bool fForceLogin, String* strCoBrandedArgs, int iLangID, String* strNameSpace, int iKPP, bool bUseSecureAuth); [VB] Public Function AuthUrl2(ByVal strReturnUrl As String, ByVal iTimeWindow As Integer, ByVal fForceLogin As Boolean, ByVal strCoBrandedArgs As String, ByVal iLangID As Integer, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal bUseSecureAuth As Boolean) As String [JScript] public function AuthUrl2(strReturnUrl: String, iTimeWindow: int, fForceLogin: Boolean, strCoBrandedArgs: String, iLangID: int, strNameSpace String, iKPP: int, bUseSecureAuth: Boolean): String;

Description

[2412] Retrieves a String containing the logon server URL for a member, as well as the optional information sent to the logon server in the query string.

Return Value. The logon server URL for a member, as well as the optional information sent to the logon server in the query string.

[2413] This URL can be used to generate a link for a member who has not signed in previously or who has an expired ticket. For more details, see IPassportManager2::AuthUrl2 in the Passport SDK documentation. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2.

[2414] AuthUrl2

[2415] [C#] public string AuthUrl2(string strReturnUrl, int iTimeWindow, int iForceLogin, string strCoBrandedArgs, int iLangID, string strNameSpace, int iKPP, int iuseSecureAuth); [C++] public: String* AuthUrl2(String* strReturnUrl, int iTimeWindow, int iForceLogin, String* strCoBrandedArgs, int iLangID, String* strNameSpace, int iKPP, int iuseSecureAuth); [VB] Public Function AuthUrl2(ByVal strReturnUrl As String, ByVal iTimeWindow As Integer, ByVal iForceLogin As Integer, ByVal strCoBrandedArgs As String, ByVal iLangID As Integer, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal iUseSecureAuth As Integer) As String [JScript] public function AuthUrl2(strReturnUrl: String, iTimeWindow: int, iForceLogin: int, strCoBrandedArgs: String, iLangID: int, strNameSpace String, iKPP: int, iUseSecureAuth: int): String;

Description

[2416] Retrieves a String containing the logon server URL for a member, as well as the optional information sent to the logon server in the query string.

Return Value: The logon server URL for a member, as well as the optional information sent to the logon server in the query string.

[2417] You can use this URL to generate a link for a member who has not previously signed in or who has an expired ticket. For more details, see IPassportManager2::AuthUrl2 in the Passport SDK documentation. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2. See Passport documentation for IPassportManager2::AuthUrl2.

[2418] Compress

[C#] public static string Compress(string strData); [C++] public: static String* Compress(String* strData); [VB] Public Shared Function Compress(ByVal strData As String) As String [JScript] public static function Compress(strData: String): String;

Description

[2419] Compresses data.

Return Value: Compressed data.

[2420] For more information about IPassportCrypt::Compress, see the Passport SDK documentation. Data to be compressed.

[2421] CryptIsValid

[C#] public static bool CryptIsValid( ); [C++] public: static bool CryptIsValid( ); [VB] Public Shared Function CryptIsValid( ) As Boolean [JScript] public static function CryptIsValid( ): Boolean;

Description

[2422] Returns true if the key used for encryption and decryption is valid and if the Passport Manager object is in a valid state for encryption.

[2423] See the Passport SDK documentation for IPassportCrypt::get_IsValid.

[2424] CryptPutHost

[2425] [C#] public static int CryptPutHost(string strHost); [C++] public: static int CryptPutHost(String* strHost); [VB] Public Shared Function CryptPutHost(ByVal strHost As String) As Integer [JScript] public static function CryptPutHost(strHost: String): int;

Description

[2426] Sets the key being used by the current Passport Crypt object by referring to the host name or IP address used by the desired installation.

[2427] See the Passport SDK documentation for IPassportCrypt::put_Host. Host name or IP address.

[2428] CryptPutSite

[2429] [C#] public static int CryptPutSite(string strSite); [C++] public: static int CryptPutSite(String* strSite); [VB] Public Shared Function CryptPutSite(ByVal strSite As String) As Integer [JScript] public static function CryptPutSite(strSite: String): int;

Description

[2430] Sets the key being used by the current Passport Crypt object by referring to the site-name label assigned to that key when the key was first installed.

[2431] See the Passport SDK documentation for IPassportCrypt::put_Site.

[2432] Decompress

[2433] [C#] public static string Decompress(string strData); [C++] public: static String* Decompress(String* strData); [VB] Public Shared Function Decompress(ByVal strData As String) As String [JScript] public static function Decompress(strData: String): String;

Description

[2434] Decompresses data that has been compressed by the Compress method.

Return Value. Decompressed data.

[2435] See the Passport SDK documentation for IPassportCrypt::Compress. Data to be decompressed.

[2436] Decrypt

[C#] public static string Decrypt(string strData); [C++] public: static String* Decrypt(String* strData); [VB] Public Shared Function Decrypt(ByVal strData As String) As String [JScript] public static function Decrypt(strData: String): String;

Description

[2437] Decrypts data using the Passport participant key for the current site.

Return Value: Decrypted data.

[2438] See the Passport SDK documentation for IPassportCrypt::Decrypt. The data to be decrypted.

[2439] Encrypt

[C#] public static string Encrypt(string strData); [C++] public: static String* Encrypt(String* strData); [VB] Public Shared Function Encrypt(ByVal strData As String) As String [JScript] public static function Encrypt(strData:String):String;

Description

[2440] Encrypts data using the Passport participant key for the current site. Maximum input size is 2045 characters.

Return Value: Encrypted data.

[2441] See the Passport SDK documentation for IPassportCrypt::Encrypt. The data to be encrypted.

[2442] Finalize

[C#] ˜PassportIdentity( ); [C++] ˜PassportIdentity( ); [VB] Overrides Protected Sub Finalize( ) [JScript] protected override function Finalize( );

Description

[2443] Calls Finalize method.

[2444] GetDomainAttribute

[2445] [C#] public string GetDomainAttribute(string strAttribute, int iLCID, string strDomain); [C++] public: String* GetDomainAttribute(String* strAttribute, int iLCID, String* strDomain); [VB] Public Function GetDomainAttribute(ByVal strAttribute As String, ByVal iLCID As Integer, ByVal strDomain As String) As String [JScript] public function GetDomainAttribute(strAttribute: String, iLCID: int, strDomain: String): String;

Description

[2446] Provides information for a Passport domain by querying the Passport CCD for the requested DomainAttribute.

[2447] For more information, see the Passport SDK documentation. The name of the attribute value to retrieve. Specifies the language in which various Passport network pages should be displayed to the member. The domain authority name to query for an attribute.

[2448] GetDomainFromMemberName

[2449] [C#] public string GetDomainFromMemberName(string strMemberName); [C++] public: String* GetDomainFromMemberName(String* strMemberName); [VB] Public Function GetDomainFromMemberName(ByVal strMemberName As String) As String [JScript] public function GetDomainFromMemberName(strMemberName: String): String;

Description

[2450] Returns the Passport domain from the member-name string. Name of the Passport member

[2451] GetIsAuthenticated

[2452] [C#] public bool GetIsAuthenticated(int iTimeWindow, bool bForceLogin, bool bCheckSecure); [C++] public: bool GetIsAuthenticated(int iTimeWindow, bool bForceLogin, bool bCheckSecure); [VB] Public Function GetIsAuthenticated(ByVal iTimeWindow As Integer, ByVal bForceLogin As Boolean, ByVal bCheckSecure As Boolean) As Boolean [JScript] public function GetIsAuthenticated(iTimeWindow: int, bForceLogin: Boolean, bCheckSecure: Boolean): Boolean; Returns true if the user is authenticated by a Passport authority.

Description

[2453] Returns true if the user is authenticated by a Passport authority.

Return Value: true if the user is authenticated by a Passport authority.

[2454] See passport documentation for IPassportManager::IsAuthenticated. Specifies the interval during which members must have last signed in to the calling domain. Determines how iTimeWindow is used. Enables checking for a secure logon.

[2455] GetIsAuthenticated

[2456] [C#] public bool GetIsAuthenticated(int iTimeWindow, int iForceLogin, int iCheckSecure); [C++] public: bool GetIsAuthenticated(int iTimeWindow, int iForceLogin, int iCheckSecure); [VB] Public Function GetIsAuthenticated(ByVal iTimeWindow As Integer, ByVal iForceLogin As Integer, ByVal iCheckSecure As Integer) As Boolean [JScript] public function GetIsAuthenticated(iTimeWindow: int, iForceLogin: int, iCheckSecure: int): Boolean;

Description

[2457] Returns true if the user is authenticated by a Passport authority.

Return Value: true if the user is authenticated by a Passport authority.

[2458] See Passport documentation for IPassportManager::IsAuthenticated. Specifies the interval during which members must have last signed in to the calling domain. Determines how iTimeWindow is used. Enables checking for a secure logon.

[2459] GetProfileObject

[2460] [C#] public object GetProfileObject(string strProfileName); [C++] public: Object* GetProfileObject(String* strProfileName); [VB] Public Function GetProfileObject(ByVal strProfileName As String) As Object [JScript] public function GetProfileObject(strProfileName: String): Object;

Description

[2461] Returns Passport profile information for the supplied profile attribute. The Passport profile attribute to query.

[2462] HasFlag

[C#] public bool HasFlag(int iFlagMask); [C++] public: bool HasFlag(int iFlagMask); [VB] Public Function HasFlag(ByVal iFlagMask As Integer) As Boolean [JScript] public function HasFlag(iFlagMask: int): Boolean;

Description

[2463] Returns true if a given flag is set in this user's profile.

[2464] For more information, see the Passport SDK documentation. The Passport profile flag to query.

[2465] HasProfile

[C#] public bool HasProfile(string strProfile); [C++] public: bool HasProfile(String* strProfile); [VB] Public Function HasProfile(ByVal strProfile As String) As Boolean [JScript] public function HasProfile(strProfile: String): Boolean;

Description

[2466] Returns true if a given profile attribute exists in this user's profile.

[2467] For more information, see the Passport SDK documentation. The Passport profile attribute to query.

[2468] HaveConsent

[2469] [C#] public bool HaveConsent(bool bNeedFullConsent, bool bNeedBirthdate); [C++] public: bool HaveConsent(bool bNeedFullConsent, bool bNeedBirthdate); [VB] Public Function HaveConsent(ByVal bNeedFullConsent As Boolean, ByVal bNeedBirthdate As Boolean) As Boolean [JScript] public function HaveConsent(bNeedFullConsent: Boolean, bNeedBirthdate: Boolean): Boolean;

Description

[2470] Returns true if Full Consent is granted in this user's profile.

[2471] For more information, see the Passport SDK documentation. true if Full Consent is required for Passport Authentication.

[2472] LoginUser

[C#] public int LoginUser( ); [C++] public: int LoginUser( ); [VB] Public Function LoginUser( ) As Integer [JScript] public function LoginUser( ): int;

Description

[2473] Logs the user on, either by generating a 302-redirect URL or initiating a Passport-aware client authentication exchange.

[2474] This method supports Passport-aware client applications. Note that there are some policy restrictions on the use of this method in certain scenarios. Note also that this method should not be called from a frameset, as suggested in the Passport documentation. Finally, this method requires that Msppfltr.dll be properly installed and running as an ISAPI filter at the global level of the participant Web site.

[2475] LoginUser

[2476] [C#] public int LoginUser(string szRetURL, int iTimeWindow, bool fForceLogin, string szCOBrandArgs, int iLangID, string strNameSpace, int iKPP, bool fUseSecureAuth, object oExtraParams); [C++] public: int LoginUser(String* szRetURL, int iTimeWindow, bool fForceLogin, String* szCOBrandArgs, int iLangID, String* strNameSpace, int iKPP, bool fUseSecureAuth, Object* oExtraParams); [VB] Public Function LoginUser(ByVal szRetURL As String, ByVal iTimeWindow As Integer, ByVal fForceLogin As Boolean, ByVal szCOBrandArgs As String, ByVal iLangID As Integer, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal fUseSecureAuth As Boolean, ByVal oExtraParams As Object) As Integer [JScript] public function LoginUser(szRetURL: String, iTimeWindow: int, fForceLogin: Boolean, szCOBrandArgs: String, iLangID: int, strNameSpace: String, iKPP: int, fUseSecureAuth: Boolean, oExtraParams: Object): int; Logs the user on, either by generating a 302-redirect URL or initiating a Passport-aware client authentication exchange.

Description

[2477] Logs the user on, either by generating a 302-redirect URL or initiating a Passport-aware client authentication exchange.

[2478] This method supports Passport-aware client applications. Note that there are some policy restrictions on the use of this method in certain scenarios. Note also that this method should not be called from a frameset, as suggested in the Passport documentation. Finally, this method requires that Msppfltr.dll be properly installed and running as an ISAPI filter at the global level of the participant Web site. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser.

[2479] LoginUser

[2480] [C#] public int LoginUser(string szRetURL, int iTimeWindow, int fForceLogin, string szCOBrandArgs, int iLangID, string strNameSpace, int iKPP, int iUseSecureAuth, object oExtraParams); [C++] public: int LoginUser(String* szRetURL, int iTimeWindow, int fForceLogin, String* szCOBrandArgs, int iLangID, String* strNameSpace, int iKPP, int iUseSecureAuth, Object* oExtraParams); [VB] Public Function LoginUser(ByVal szRetURL As String, ByVal iTimeWindow As Integer, ByVal fForceLogin As Integer, ByVal szCOBrandArgs As String, ByVal iLangID As Integer, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal iUseSecureAuth As Integer, ByVal oExtraParams As Object) As Integer [JScript] public function LoginUser(szRetURL: String, iTimeWindow: int, fForceLogin: int, szCOBrandArgs: String, iLangID: int, strNameSpace: String, iKPP: int, iUseSecureAuth: int, oExtraParams: Object): int;

Description

[2481] Logs the user on, either by generating a 302-redirect URL or initiating a Passport-aware client authentication exchange.

[2482] This method supports Passport-aware client applications. Note that there are some policy restrictions on the use of this method in certain scenarios. Note also that this method should not be called from a frameset, as suggested in the Passport documentation. Finally, this method requires that Msppfltr.dll be properly installed and running as an ISAPI filter at the global level of the participant Web site. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser.

[2483] LogoTag

[C#] public string LogoTag( ); [C++] public: String* LogoTag( ); [VB] Public Function LogoTag( ) As String [JScript] public function LogoTag( ): String;

Description

[2484] Returns an HTML snippet containing an image tag for a Passport link. This is based on the current state of the identity (already signed in, and such).

[2485] LogoTag

[2486] [C#] public string LogoTag(string strReturnUrl, int iTimeWindow, bool fForceLogin, string strCoBrandedArgs, int iLangID, bool fSecure, string strNameSpace, int iKPP, bool bUseSecureAuth); [C++] public: String* LogoTag(String* strReturnUrl, int iTimeWindow, bool fForceLogin, String* strCoBrandedArgs, int iLangID, bool fSecure, String* strNameSpace, int iKPP, bool bUseSecureAuth); [VB] Public Function LogoTag(ByVal strReturnUrl As String, ByVal iTimeWindow As Integer, ByVal fForceLogin As Boolean, ByVal strCoBrandedArgs As String, ByVal iLangID As Integer, ByVal fSecure As Boolean, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal bUseSecureAuth As Boolean) As String [JScript] public function LogoTag(strReturnUrl: String, iTimeWindow: int, fForceLogin: Boolean, strCoBrandedArgs: String, iLangID: int, fSecure: Boolean, strNameSpace: String, iKPP: int, bUseSecureAuth: Boolean): String;

Description

[2487] Similar to LogoTag( ), this method returns an HTML snippet for the Passport Logo for the current member

[2488] For additional details on the parameters for this method, see the Passport SDK documentation. Sets the URL of the location that the Login server should redirect members to after sign-in is complete. Specifies the interval during which 11 members must have last signed in. Determines how iTimeWindow gets used. Specifies variables to be appended as query string variables to the URL of the participant's Co-branding Template script page. Specifies the language to be used for the Login page that is displayed to the member. Declares whether this method is being called from an HTTPS (SSL) page. Specifies the domain in which the Passport should be created. Specifies data collection policies for purposes of COPPA compliance. Declares whether the actual sign-in UT should be served HTTPS from the Passport domain authority.

[2489] LogoTag

[2490] [C#] public string LogoTag(string strReturnUrl, int iTimeWindow, int iForceLogin, string strCoBrandedArgs, int iLangID, int iSecure, string strNameSpace, int iKPP, int iUseSecureAuth); [C++] public: String* LogoTag(String* strReturnUrl, int iTimeWindow, int iForceLogin, String* strCoBrandedArgs, int iLangID, int iSecure, String* strNameSpace, int iKPP, int iUseSecureAuth); [VB] Public Function LogoTag(ByVal strReturnUrl As String, ByVal iTimeWindow As Integer, ByVal iForceLogin As Integer, ByVal strCoBrandedArgs As String, ByVal iLangID As Integer, ByVal iSecure As Integer, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal iUseSecureAuth As Integer) As String [JScript] public function LogoTag(strReturnUrl: String, iTimeWindow: int, iForceLogin: int, strCoBrandedArgs: String, iLangID: int, iSecure: int, strNameSpace: String, iKPP: int, iUseSecureAuth: int): String;

Description

[2491] LogoTag2

[2492] [C#] public string LogoTag2( ); [C++] public: String* LogoTag2( ); [VB] Public Function LogoTag2( ) As String [JScript] public function LogoTag2( ): String; Returns an HTML fragment containing an <img> tag for a Passport link. This is based on the current state of the identity (already logged on, and so on).

Description

[2493] Returns an HTML fragment containing an <img> tag for a Passport link. This is based on the current state of the identity (already logged on, and so on).

[2494] The link image displays either Sign In if no valid ticket cookie is detected, or Sign Out if a valid cookie ticket is detected. For more details, see IPassportManager2::LogoTag2 in the Passport SDK documentation.

[2495] LogoTag2

[2496] [C#] public string LogoTag2(string strReturnUrl, int iTimeWindow, bool fForceLogin, string strCoBrandedArgs, int iLangID, bool fSecure, string strNameSpace, int iKPP, bool bUseSecureAuth); [C++] public: String* LogoTag2(String* strReturnUrl, int iTimeWindow, bool fForceLogin, String* strCoBrandedArgs, int iLangID, bool fSecure, String* strNameSpace, int iKPP, bool bUseSecureAuth); [VB] Public Function LogoTag2(ByVal strReturnUrl As String, ByVal iTimeWindow As Integer, ByVal fForceLogin As Boolean, ByVal strCoBrandedArgs As String, ByVal iLangID As Integer, ByVal fSecure As Boolean, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal bUseSecureAuth As Boolean) As String [JScript] public function LogoTag2(strReturnUrl: String, iTimeWindow: int, fForceLogin: Boolean, strCoBrandedArgs: String, iLangID: int, fSecure: Boolean, strNameSpace: String, iKPP: int, bUseSecureAuth: Boolean): String;

Description

[2497] Returns an HTML fragment containing an <img> tag for a Passport link. This is based on the current state of the identity (already logged on, and so on).

[2498] The link image displays either Sign In if no valid ticket cookie is detected, or Sign Out if a valid cookie ticket is detected. For more details, see IPassportManager2::LogoTag2 in the Passport SDK documentation. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser.

[2499] LogoTag2

[2500] [C#] public string LogoTag2(string strReturnUrl, int iTimeWindow, int iForceLogin, string strCoBrandedArgs, int iLangID, int iSecure, string strNameSpace, int iKPP, int iUseSecureAuth); [C++] public: String* LogoTag2(String* strReturnUrl, int iTimeWindow, int iForceLogin, String* strCoBrandedArgs, int iLangID, int iSecure, String* strNameSpace, int iKPP, int iUseSecureAuth); [VB] Public Function LogoTag2(ByVal strReturnUrl As String, ByVal iTimeWindow As Integer, ByVal iForceLogin As Integer, ByVal strCoBrandedArgs As String, ByVal iLangID As Integer, ByVal iSecure As Integer, ByVal strNameSpace As String, ByVal iKPP As Integer, ByVal iUseSecureAuth As Integer) As String [JScript] public function LogoTag2(strReturnUrl: String, iTimeWindow: int, iForceLogin: int, strCoBrandedArgs: String, iLangID: int, iSecure: int, strNameSpace: String, iKPP: int, iUseSecureAuth: int): String;

Description

[2501] Returns an HTML fragment containing an <img> tag for a Passport link. This is based on the current state of the identity (already logged on, and so on).

[2502] The link image displays either Sign In if no valid ticket cookie is detected, or Sign Out if a valid cookie ticket is detected. For more details, see IPassportManager2::LogoTag2 in the Passport SDK documentation. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser. See Passport documentation for IPassportManager2::LoginUser.

[2503] SignOut

[2504] [C#] public static void SignOut(string strSignOutDotGifFileName); [C++] public: static void SignOut(String* strSignOutDotGifFileName); [VB] Public Shared Sub SignOut(ByVal strSignOutDotGifFileName As String) [JScript] public static function SignOut(strSignOutDotGifFileName: String);

Description

[2505] Logs off the given Passport member from the current session.

[2506] For more information, see the Passport SDK documentation. The SignOut image to be used.

[2507] UrlAuthorizationModule class (System.Web.Security)

[2508] ToString

Description

[2509] Provides URL-based authorization services for allowing or denying access to specified resources. This class cannot be inherited.

[2510] UrlAuthorizationModule

[2511] Example Syntax:

[2512] ToString

[C#] public UrlAuthorizationModule( ); [C++] public: UrlAuthorizationModule( ); [VB] Public Sub New( ) [JScript] public function UrlAuthorizationModule( );

[2513] Dispose

[C#] public void Dispose( ); [C++] public: _sealed void Dispose( ); [VB] NotOverridable Public Sub Dispose( ) [JScript] public function Dispose( );

Description

[2514] Called by the HTTP runtime to dispose of the module.

[2515] Call System.Web.Security.UrlAuthorizationModule.Dispose when you are finished using the System.Web.Security.UrlAuthorizationModule. The System.Web.Security.UrlAuthorizationModule.Dispose method leaves the System.Web.Security.UrlAuthorizationModule in an unusable state. After calling System.Web.Security.UrlAuthorizationModule.Dispose, you must release all references to the System.Web.Security.UrlAuthorizationModule so the memory it occupid can be reclaimed by garbage collection.

[2516] Init

[C#] public void Init(HttpApplication app); [C++] public: _sealed void Init(HttpApplication* app); [VB] NotOverridable Public Sub Init(ByVal app As HttpApplication) [JScript] public function Init(app: HttpApplication);

Description

[2517] Initializes the module. The Http application.

[2518] WindowsAuthenticationEventArgs class (System.Web.Security)

[2519] ToString

Description

[2520] Provides data for the WindowsAuthentication event.

[2521] This is the event argument passed to the WindowsAuthentication_OnAuthenticate event handler. Contains a WindowsIdentity object and the IPrincipal object used for the context.

[2522] WindowsAuthenticationEventArgs

[2523] Example Syntax:

[2524] ToString

[2525] [C#] public WindowsAuthenticationEventArgs(WindowsIdentity identity, HttpContext context); [C++] public: WindowsAuthenticationEventArgs(WindowsIdentity* identity, HttpContext* context); [VB] Public Sub New(ByVal identity As WindowsIdentity, ByVal context As HttpContext) [JScript] public function WindowsAuthenticationEventArgs(identity: WindowsIdentity, context: HttpContext);

Description

[2526] Initializes a newly created instance of the WindowsAuthenticationEventArgs Class. The windows identity object. The context for the event.

[2527] Context

[2528] ToString

[C#] public HttpContext Context {get;} [C++] public: _property HttpContext* get_Context( ); [VB] Public ReadOnly Property Context As HttpContext [JScript] public function get Context( ): HttpContext;

Description

[2529] The HttpContext intrinsic (provides access to Request, Response, and User objects).

[2530] Identity

[2531] ToString

[C#] public WindowsIdentity Identity {get;} [C++] public: _property WindowsIdentity* get_Identity( ); [VB] Public ReadOnly Property Identity As WindowsIdentity [JScript] public function get Identity( ): WindowsIdentity;

Description

[2532] An authenticated Windows identity.

[2533] User

[2534] ToString

[2535] [C#] public IPrincipal User {get; set;} [C++] public: _property IPrincipal* get_User( );public: _property void set_User(IPrincipal*); [VB] Public Property User As IPrincipal [JScript] public function get User( ): IPrincipal;public function set User(IPrincipal);

Description

[2536] IPrincipal object to be associated with the request. The user object should be attached to the contextIf User is non null and Context.User is null, the WindowsAuthenticationModule will initialize Context.User with WindowsAuthenticationEventArgs.User.

[2537] WindowsAuthenticationEventHandler delegate (System.Web.Security)

[2538] ToString

Description

[2539] Represents the method that handles the WindowsAuthentication_OnAuthenticate event of a WindowsAuthenticationModule. The source of the event. A WindowsAuthenticationEventArg that contains the event data.

[2540] When you create a System.Web.Security.WindowsAuthenticationEventHandler delegate, you identify the method to handle the event. To associate the event with your EventHandler, add an instance of the delegate to the event. The EventHandler is called whenever the event occurs, unless you remove the delegate. For more information about EventHandler delegates, see.

[2541] WindowsAuthenticationModule class (System.Web.Security)

[2542] ToString

Description

[2543] Enables ASP.NET applications to use Windows/IIS authentication. This class cannot be inherited.

[2544] WindowsAuthenticationModule

[2545] Example Syntax:

[2546] ToString

[C#] public WindowsAuthenticationModule( ); [C++] public: WindowsAuthenticationModule( ); [VB] Public Sub New( ) [JScript] public function WindowsAuthenticationModule( );

[2547] ToString

[C#] public event WindowsAuthenticationEventHandler Authenticate; [C++] public: _event WindowsAuthenticationEventHandler* Authenticate; [VB] Public Event Authenticate As WindowsAuthenticationEventHandler

Description

[2548] Raised during authentication. This is a Global.asax event that must be named PassportAuthentication_OnAuthenticate event. It is used primarily to attach a custom IPrincipal object to the context.

[2549] For more information about handling events, see.

[2550] Dispose

[C#] public void Dispose( ); [C++] public: _sealed void Dispose( ); [VB] NotOverridable Public Sub Dispose( ) [JScript] public function Dispose( );

Description

[2551] Disposes of the module derived from IHttpModule when called by the HttpRuntime.

[2552] Call System.Web.Security.WindowsAuthenticationModule.Dispose when you are finished using the System.Web.Security.WindowsAuthenticationModule. The System.Web.Security.WindowsAuthenticationModule.Dispose method leaves the System.Web.Security.WindowsAuthenticationModule in an unusable state. After calling System.Web.Security.WindowsAuthenticationModule.Dispose, you must release all references to the System.Web.Security.WindowsAuthenticationModule so the memory it occupied can be reclaimed by garbage collection.

[2553] Init

[C#] public void Init(HttpApplication app); [C++] public: _sealed void Init(HttpApplication* app); [VB] NotOverridable Public Sub Init(ByVal app As HttpApplication) [JScript] public function Init(app: HttpApplication);

Description

[2554] Initializes the module derived from IHttpModule when cal

System.Web.Services

Description

[2555] The System.Web.Services namespace consists of the classes that enable you to build and use Web Services. A Web Service is a programmable entity residing on a Web Server exposed via standard Internet protocols.

[2556] WebMethodAttribute class (System.Web.Services)

Description

[2557] Adding this attribute to a method within an ASP.NET Web Service makes the method callable from remote Web clients. This class cannot be inherited.

[2558] Methods within a class that have this attribute set are called Web Service methods. The method and class must be public and running inside an ASP.NET Web application.

[2559] Constructors:

[2560] WebMethodAttribute

[2561] Example Syntax:

[C#] public WebMethodAttribute( ); [C++] public: WebMethodAttribute( ); [VB] Public Sub New( ) [JScript] public function WebMethodAttribute( ); Initializes a new instance of the System.Web.Services.WebMethodAttribute class.

Description

[2562] Initializes a new instance of the System.Web.Services.WebMethodAttribute class.

[2563] WebMethodAttribute

[2564] Example Syntax:

[C#] public WebMethodAttribute(bool enableSession); [C++] public: WebMethodAttribute(bool enableSession); [VB] Public Sub New(ByVal enableSession As Boolean) [JScript] public function WebMethodAttribute(enableSession: Boolean);

Description

[2565] Initializes a new instance of the System.Web.Services.WebMethodAttribute class. Initializes whether session state is enabled for the Web Service method.

[2566] WebMethodAttribute

[2567] Example Syntax:

[2568] [C#] public WebMethodAttribute(bool enableSession, TransactionOption transactionOption); [C++] public: WebMethodAttribute(bool enableSession, TransactionOption transactionOption); [VB] Public Sub New(ByVal enableSession As Boolean, ByVal transactionOption As TransactionOption) [JScript] public function WebMethodAttribute(enableSession: Boolean, transactionOption: TransactionOption);

Description

[2569] Initializes a new instance of the System.Web.Services.WebMethodAttribute class. Initializes whether session state is enabled for the Web Service method. Initializes the transaction support of a Web Service method.

[2570] WebMethodAttribute

[2571] Example Syntax:

[2572] [C#] public WebMethodAttribute(bool enableSession, TransactionOption transactionOption, int cacheDuration); [C++] public: WebMethodAttribute(bool enableSession, TransactionOption transactionOption, int cacheDuration); [VB] Public Sub New(ByVal enableSession As Boolean, ByVal transactionOption As TransactionOption, ByVal cacheDuration As Integer) [JScript] public function WebMethodAttribute(enableSession: Boolean, transactionOption: TransactionOption, cacheDuration: int);

Description

[2573] Initializes a new instance of the System.Web.Services.WebMethodAttribute class. Initializes whether session state is enabled for the Web Service method. Initializes the transaction support of a Web Service method. Initializes the number of seconds the response is cached.

[2574] WebMethodAttribute

[2575] Example Syntax:

[2576] [C#] public WebMethodAttribute(bool enableSession, TransactionOption transactionOption, int cacheDuration, bool bufferResponse); [C++] public: WebMethodAttribute(bool enableSession, TransactionOption transactionOption, int cacheDuration, bool bufferResponse); [VB] Public Sub New(ByVal enableSession As Boolean, ByVal transactionOption As TransactionOption, ByVal cacheDuration As Integer, ByVal bufferResponse As Boolean) [JScript] public function WebMethodAttribute(enableSession: Boolean, transactionOption: TransactionOption, cacheDuration: int, bufferResponse Boolean);

Description

[2577] Initializes a new instance of the System.Web.Services.WebMethodAttribute class. Initializes whether session state is enabled for the Web Service method. Initializes the transaction support of a Web Service method. Initializes the number of seconds the response is cached. Initializes whether the response for this request is buffered.

[2578] Properties:

[2579] BufferResponse

[2580] [C#] public bool BufferResponse {get; set;} [C++] public: _property bool get_BufferResponse( );public: _property void set_BufferResponse(bool); [VB] Public Property BufferResponse As Boolean [JScript] public function get BufferResponse( ): Boolean;public function set BufferResponse(Boolean);

Description

[2581] Gets or sets whether the response for this request is buffered.

[2582] Setting System.Web.Services.WebMethodAttribute.BufferResponse to true, serializes the response of the Web Service method into a memory buffer until either the response is completely serialized or the buffer is full. Once the response is buffered, it is returned to the Web Service client over the network. When System.Web.Services.WebMethodAttribute.BufferResponse is false, the response to the Web Service method is sent back to the client as it is serialized. In general, you only want to set System.Web.Services.WebMethodAttribute.BufferResponse to false, if it is known that a Web Service method returns large amounts of data to the client. For smaller amounts of data, Web Service performance is better with System.Web.Services.WebMethodAttribute.BufferResponse to true.

[2583] CacheDuration

[2584] [C#] public int CacheDuration {get; set;} [C++] public: _property int get_CacheDuration( );public: _property void set_CacheDuration(int); [VB] Public Property CacheDuration As Integer [JScript] public function get CacheDuration( ): int;public function set CacheDuration(int);

Description

[2585] Gets or sets the number of seconds the response should be held in the cache.

[2586] When caching is enabled requests and responses are held in memory on the server for at least the cache duration so caution must be used if you expect requests or responses to be very large or you expect requests to vary widely.

[2587] Description

[2588] [C#] public string Description {get; set;} [C++] public: _property String* get_Description( );public: _property void set_Description (String*); [VB] Public Property Description As String [JScript] public function get Description( ): String;public function set Description (String);

Description

[2589] A descriptive message describing the Web Service method.

[2590] The descriptive message is displayed to prospective consumers of the Web Service when description documents for the Web Service are generated, such as the Service Description and the Service help page.

[2591] EnableSession

[2592] [C#] public bool EnableSession {get; set;} [C++] public: _property bool get_EnableSession( );public: _property void set_EnableSession(bool); [VB] Public Property EnableSession As Boolean [JScript] public function get EnableSession( ): Boolean;public function set EnableSession(Boolean);

Description

[2593] Indicates whether session state is enabled for a Web Service method.

[2594] In order to store session state in the ASP.NET System.Web.SessionState.HttpSessionState object, the Web Service must inherit from System.Web.Services.WebService and a System.Web.Services.WebMethodAttribute applied to the Web Service method, setting the System.Web.Services.WebMethodAttribute.EnableSession property to true. If session state is not needed for a Web Service method, then disabling it may improve performance.

[2595] MessageName

[2596] [C#] public string MessageName {get; set;} [C++] public: _property String* get_MessageName( );public: _property void set_MessageName(String*); [VB] Public Property MessageName As String [JScript] public function get MessageName( ): String;public function set MessageName(String);

Description

[2597] The name used for the Web Service method in the data passed to and returned from a Web Service method.

[2598] The System.Web.Services.WebMethodAttribute.MessageName property can be used to alias method or property names. The most common use of the System.Web.Services.WebMethodAttribute.MessageName property will be to uniquely identify polymorphic methods. By default, System.Web.Services.WebMethodAttribute.MessageName is set to the name of the Web Service method. Therefore, if a Web Service contains two or more Web Service methods with the same name, you can uniquely identify the individual Web Service methods by setting the System.Web.Services.WebMethodAttribute.MessageName to a name unique within the Web Service, without changing the name of the actual method name in code.

[2599] TransactionOption

[2600] [C#] public TransactionOption TransactionOption {get; set;} [C++] public: _property TransactionOption get_TransactionOption( );public: _property void set_TransactionOption(TransactionOption); [VB] Public Property TransactionOption As TransactionOption [JScript] public function get TransactionOption( ): TransactionOption;public function set TransactionOption(TransactionOption);

Description

[2601] Indicates the transaction support of a Web Service method.

[2602] Web Service methods can only participate as the root object in a transaction, due to the stateless nature of the HTTP protocol. Web Service methods can invoke COM objects that participate in the same transaction as the Web Service method, if the COM object is marked to run within a transaction in the Component Services administrative tool. If a Web Service method, with a System.Web.Services.WebMethodAttribute.TransactionOption property of Required or RequiresNew invokes another Web Service method with a System.Web.Services.WebMethodAttribute.TransactionOption property of Required or RequiresNew, each Web Service method participates in their own transaction, because a Web Service method can only act as the root object in a transaction.

[2603] TypeId

[2604] Methods:

[2605] WebService class (System.Web.Services)

[2606] ToString

Description

[2607] Defines the optional base class for Web Services, which provides direct access to common ASP.NET objects, like those for application and session state.

[2608] If you don't need access to the common ASP.NET objects, you can still create a Web Service without deriving from System.Web.Services.WebService. Additional ASP.NET objects can be accessed through System.Web.Services.WebService.Context.

[2609] WebService

[2610] Example Syntax:

[2611] ToString

[C#] public WebService( ); [C++] public: WebService( ); [VB] Public Sub New( ) [JScript] public function WebService( );

[2612] Application

[2613] ToString

[2614] [C#] public HttpApplicationState Application {get;} [C++] public: _property HttpApplicationState* get_Application( ); [VB] Public ReadOnly Property Application As HttpApplicationState [JScript] public function get Application( ): HttpApplicationState;

Description

[2615] Gets the application object for the current HTTP request.

[2616] Web Services can utilize both application state and session state. Application state is maintained across all sessions accessing a Web Service regardless of whether session state is turned off for a method(by using the System.Web.Services.WebMethodAttribute.EnableSession property of the System.Web.Services.WebMethodAttribute).

[2617] Container

[2618] Context

[2619] ToString

Description

[2620] Gets the ASP.NET System.Web.HttpContext for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests.

[2621] If a Web Service method is one-way, then the System.Web.Services.WebService.Context property is always null. A Web Service is one-way when a System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapRpcMethodAttribute is applied to a Web Service method and the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property is set to true.

[2622] DesignMode

[2623] Events

[2624] Server

[2625] ToString

Description

[2626] Gets the System.Web.HttpServerUtility for the current request.

[2627] The System.Web.HttpServerUtility class provides several methods that can be used in the processing of Web requests, including System.Web.HttpServerUtility.CreateObject(System.String) (for instantiating COM objects).

[2628] Session

[2629] ToString

[C#] public HttpSessionState Session {get;} [C++] public: _property HttpSessionState* get_Session( ); [VB] Public ReadOnly Property Session As HttpSessionState [JScript] public function get Session( ): HttpSessionState;

Description

[2630] Gets the System.Web.SessionState.HttpSessionState instance for the current request.

[2631] If a Web Service method is one-way, then the System.Web.Services.WebService.Session property is always null. A Web Service is one-way when a System.Web.Services.Protocols.SoapDocumentMethodAttribute or System.Web.Services.Protocols.SoapRpcMethodAttribute is applied to a Web Service method and the System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay property is set to true

[2632] Site

[2633] User

[2634] ToString

Description

[2635] Gets the ASP.NET server System.Web.HttpContext.User object. Can be used to authenticate whether a user is authorized to execute the request.

[2636] Both Internet Information Services (IIS) and the NET Framework need to be configured for authentication in order for the System.Web.Services.WebService.User property to be meaningful. Authentication is the process of accepting credentials from a user and validating those credentials against some authority. If the credentials are valid, you have an authenticated identity. Authentication in the .NET Framework is configured by placing entries in the web.config file. Placing the XML in the following code into a web.config file sets the authentication mode to Windows.

[2637] WebServiceAttribute class (System.Web.Services)

[2638] ToString

Description

[2639] Used to add additional information to a Web Service, such as a string describing its functionality.

[2640] The System.Web.Services.WebServiceAttribute is not required for a Web Service to be published and executed. You can use the WebServiceAttribute to specify a name for the Web Service that is not restricted by the rules for a Common Language Runtime identifier, which is used in the Service Description and the Service help page for the Web Service.

[2641] ToString

[C#] public const string DefaultNamespace; [C++] public: const String* DefaultNamespace; [VB] Public Const DefaultNamespace As String [JScript] public var DefaultNamespace: String;

Description

[2642] The default value for the System.Web.Services.WebServiceAttribute.Namespace property. This field is constant.

[2643] WebServiceAttribute

[2644] Example Syntax:

[2645] ToString

[C#] public WebServiceAttribute( ); [C++] public: WebServiceAttribute( ); [VB] Public Sub New( ) [JScript] public function WebServiceAttribute( );

Description

[2646] Initializes a new instance of the System.Web.Services.WebServiceAttribute class.

[2647] Description

[2648] ToString

[2649] [C#] public string Description {get; set;} [C++] public: _property String* get_Description( );public: _property void set_Description (String*); [VB] Public Property Description As String [JScript] public function get Description( ): String;public function set

[2650] Description (String);

Description

[2651] A descriptive message for the Web Service.

[2652] The descriptive message is displayed to prospective consumers of the Web Service when description documents for the Web Service are generated, such as the Service Description and the Service help page.

[2653] Name

[2654] ToString

[C#] public string Name {get; set;} [C++] public: _property String* get_Name( );public: _property void set_Name(String*); [VB] Public Property Name As String [JScript] public function get Name( ): String;public function set Name(String);

Description

[2655] Gets or sets the name of the ASP.NET Web Service.

[2656] The Service Description is generated when a user navigates to the URL for the Web Service and supplies a query string of ?WSDL. Within the Service Description, the System.Web.Services.WebServiceAttribute.Name property identifies the local part of the XML qualified name for the Web Service. The Name property is also used to display the name of the Web Service on the Service help page. The Service help page is displayed when a prospective consumer navigates to the .asmx page for the Web Service without specifying a Web Service method name and its parameters.

[2657] Namespace

[2658] ToString

[2659] [C#] public string Namespace {get; set;} [C++] public: _property String* get_Namespace( );public: _property void set_Namespace(String*); [VB] Public Property Namespace As String [JScript] public function get Namespace( ): String;public function set Namespace(String);

Description

[2660] Gets or sets the default XML namespace to use for the Web Service.

[2661] XML namespaces offer a way to create names in an XML document that are identified by a Uniform Resource Identifier (URI). By using XML namespaces you can uniquely identify elements or attributes in a XML document. The Service Description for a Web Service is defined in XML, specifically in Web Service Description Language (WSDL).

[2662] TypeId

[2663] WebServiceBindingAttribute class (System.Web.Services)

[2664] ToString

Description

[2665] Declares the binding one or more Web Service methods implemented within the class implementing the Web Service. This class cannot be inherited.

[2666] A binding, as defined by Web Services Description Language(WSDL), is similar to an interface, in that it defines a concrete set of operations. Each Web Service method is an operation within a particular binding. Web Service methods are members of either the default binding for a Web Service or in a binding specified within a System.Web.Services.WebServiceBindingAttribute applied to a class implementing a Web Service. A Web Service can implement multiple bindings, by applying multiple System.Web.Services.WebServiceBindingAttribute attributes to a Web Service.

[2667] WebServiceBindingAttribute

[2668] Example Syntax:

[2669] ToString

[2670] [C#] public WebServiceBindingAttribute( ); [C++] public: WebServiceBindingAttribute( ); [VB] Public Sub New( ) [JScript] public function WebServiceBindingAttribute( ); Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class.

Description

[2671] Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class.

[2672] WebServiceBindingAttribute

[2673] Example Syntax:

[2674] ToString

[C#] public WebServiceBindingAttribute(string name); [C++] public: WebServiceBindingAttribute(String* name); [VB] Public Sub New(ByVal name As String) [JScript] public function WebServiceBindingAttribute(name: String);

Description

[2675] Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class setting the name of the binding the Web Service method is implementing.

[2676] This constructor is used to specify a name for a binding defined in the Web Service it is applied to and is a member of the default namespace. The name of the binding a Web Service method is implementing an operation for. Sets the System.Web.Services.WebServiceBindingAttribute.Name property.

[2677] WebServiceBindingAttribute

[2678] Example Syntax:

[2679] ToString

[2680] [C#] public WebServiceBindingAttribute(string name, string ns); [C++] public: WebServiceBindingAttribute(String* name, String* ns); [VB] Public Sub New(ByVal name As String, ByVal ns As String) [JScript] public function WebServiceBindingAttribute(name: String, ns: String);

Description

[2681] Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class.

[2682] This constructor is used to specify a name for a binding defined in the Web Service it is applied to that and is a member of the supplied namespace. The name of the binding a Web Service method is implementing an operation for. Sets the System.Web.Services.WebServiceBindingAttribute.Name property. The namespace associated with the binding. Sets the System.Web.Services.WebServiceBindingAttribute.Namespace property.

[2683] WebServiceBindingAttribute

[2684] Example Syntax:

[2685] ToString

[2686] [C#] public WebServiceBindingAttribute(string name, string ns, string location); [C++] public: WebServiceBindingAttribute(String* name, String* ns, String* location); [VB] Public Sub New(ByVal name As String, ByVal ns As String, ByVal location As String) [JScript] public function WebServiceBindingAttribute(name: String, ns: String, location: String);

Description

[2687] Initializes a new instance of the System.Web.Services.WebServiceBindingAttribute class.

[2688] This constructor is used to specify a name for a binding not defined in the Web Service it is applied to that and is a member of the supplied namespace. The name of the binding a Web Service method is implementing an operation for. Sets the System.Web.Services.WebServiceBindingAttribute.Name property. The namespace associated with the binding. Sets the System.Web.Services.WebServiceBindingAttribute.Namespace property. The location where the binding is defined.

[2689] Location

[2690] ToString

[2691] [C#] public string Location {get; set;} [C++] public: _property String* get_Location( );public: _property void set_Location(String*); [VB] Public Property Location As String [JScript] public function get Location( ); String;public function set Location(String);

Description

[2692] Gets or sets the location where the binding is defined.

[2693] Name

[2694] ToString

[C#] public string Name {get; set;} [C++] public: _property String* get_Name( );pub

System.Web.Services.Configuration

Description

[2695] WebServicesConfigurationSectionHandler class (System.Web.Services.Configuration)

Description

[2696] The configuration section handler for the webServices section of the Config.Web configuration file. The section handler participates in the resolution of configuration settings within the webServices portion of a Config.Web.

[2697] Constructors:

[2698] WebServicesConfigurationSectionHandler

[2699] Example Syntax:

[C#] public WebServicesConfigurationSectionHandler( ); [C++] public: WebServicesConfigurationSectionHandler( ); [VB] Public Sub New( ) [JScript] public function WebServicesConfigurationSectionHandler( );

[2700] Methods:

[2701] Create

[2702] [C#] public object Create(object parent, object configContext, XmlNode section); [C++] public: _sealed Object* Create(Object* parent, Object* configContext, XmlNode* section); [VB] NotOverridable Public Function Create(ByVal parent As Object, ByVal configContext As Object, ByVal section As XmlNode) As Object [JScript] public function Create(parent: Object, configContext: Object, section: XmlNode): Object;

Description

[2703] Parses the configuration settings for the webServices portion of a Web.config configuration file to populate the values of a WebServicesConfiguration object and returning it. Reference to the “default” value provided by the parent IConfigurationSectionHandler. Provides access to the raw XML contents within a configuration file. The virtual path for which the configuration section handler should compute values.

[2704] XmlFormatExtensionAttribute class (System.Web.Services.Configuration)

[2705] ToString

Description

[2706] XmlFormatExtensionAttribute

[2707] Example Syntax:

[2708] ToString

[C#] public XmlFormatExtensionAttribute( ); [C++] public: XmlFormatExtensionAttribute( ); [VB] Public Sub New( ) [JScript] public function XmlFormatExtensionAttribute( );

Description

[2709] XmlFormatExtensionAttribute

[2710] Example Syntax:

[2711] ToString

[2712] [C#] public XmlFormatExtensionAttribute(string elementName, string ns, Type extensionPoint1); [C++] public: XmlFormatExtensionAttribute(String* elementName, String* ns, Type* extensionPoint1); [VB] Public Sub New(ByVal elementName As String, ByVal ns As String, ByVal extensionPoint1 As Type) [JScript] public function XmlFormatExtensionAttribute(elementName: String, ns: String, extensionPoint1: Type);

[2713] XmlFormatExtensionAttribute

[2714] Example Syntax:

[2715] ToString

[2716] [C#] public XmlFormatExtensionAttribute(string elementName, string ns, Type[ ] extensionPoints); [C++] public: XmlFormatExtensionAttribute(String* elementName, String* ns, Type* extensionPoints[ ]); [VB] Public Sub New(ByVal elementName As String, ByVal ns As String, ByVal extensionPoints( ) As Type) [JScript] public function XmlFormatExtensionAttribute(elementName: String, ns: String, extensionPoints: Type[ ]);

Description

[2717] XmlFormatExtensionAttribute

[2718] Example Syntax:

[2719] ToString

[2720] [C#] public XmlFormatExtensionAttribute(string elementName, string ns, Type extensionPoint1, Type extensionPoint2); [C++] public: XmlFormatExtensionAttribute(String* elementName, String* ns, Type* extensionPoint1, Type* extensionPoint2); [VB] Public Sub New(ByVal elementName As String, ByVal ns As String, ByVal extensionPoint1 As Type, ByVal extensionPoint2 As Type) [JScript] public function XmlFormatExtensionAttribute(elementName: String, ns: String, extensionPoint1: Type, extensionPoint2: Type);

[2721] XmlFormatExtensionAttribute

[2722] Example Syntax:

[2723] ToString

[2724] [C#] public XmlFormatExtensionAttribute(string elementName, string ns, Type extensionPoint1, Type extensionPoint2, Type extensionPoint3); [C++] public: XmlFormatExtensionAttribute(String* elementName, String* ns, Type* extensionPoint1, Type* extensionPoint2, Type* extensionPoint3); [VB] Public Sub New(ByVal elementName As String, ByVal ns As String, ByVal extensionPoint1 As Type, ByVal extensionPoint2 As Type, ByVal extensionPoint3 As Type) [JScript] public function XmlFormatExtensionAttribute(elementName: String, ns: String, extensionPoint1: Type, extensionPoint2: Type, extensionPoint3: Type);

[2725] XmlFormatExtensionAttribute

[2726] Example Syntax:

[2727] ToString

[2728] [C#] public XmlFormatExtensionAttribute(string elementName, string ns, Type extensionPoint1, Type extensionPoint2, Type extensionPoint3, Type extensionPoint4); [C++] public: XmlFormatExtensionAttribute(String* elementName, String* ns, Type* extensionPoint1, Type* extensionPoint2, Type* extensionPoint3, Type* extensionPoint4); [VB] Public Sub New(ByVal elementName As String, ByVal ns As String, ByVal extensionPoint1 As Type, ByVal extensionPoint2 As Type, ByVal extensionPoint3 As Type, ByVal extensionPoint4 As Type) [JScript] public function XmlFormatExtensionAttribute(elementName: String, ns: String, extensionPoint1: Type, extensionPoint2: Type, extensionPoint3: Type, extensionPoint4: Type);

[2729] Properties:

[2730] ElementName

[2731] ToString

[2732] [C#] public string ElementName {get; set;} [C++] public: _property String* get_ElementName( );public: _property void set_ElementName(String*); [VB] Public Property ElementName As String [JScript] public function get ElementName( ): String;public function set ElementName(String);

Description

[2733] ExtensionPoints

[2734] ToString

[2735] [C#] public Type[ ] ExtensionPoints {get; set;} [C++] public: _property Type* get_ExtensionPoints( );public: _property void set_ExtensionPoints(Type*[ ]); [VB] Public Property ExtensionPoints As Type( ) [JScript] public function get ExtensionPoints( ): Type[ ];public function set ExtensionPoints(Type[ ]);

Description

[2736] Namespace

[2737] ToString

[2738] [C#] public string Namespace {get; set;} [C++] public: _property String* get_Namespace( );public: _property void set_Namespace(String*); [VB] Public Property Namespace As String [JScript] public function get Namespace( ): String;public function set Namespace(String);

Description

[2739] TypeId

[2740] XmlFormatExtensionPointAttribute class (System.Web.Services.Configuration)

[2741] ToString

Description

[2742] XmlFormatExtensionPointAttribute

[2743] Example Syntax:

[2744] ToString

[2745] [C#] public XmlFormatExtensionPointAttribute(string memberName); [C++] public: XmlFormatExtensionPointAttribute(String* memberName); [VB] Public Sub New(ByVal memberName As String) [JScript] public function XmlFormatExtensionPointAttribute(memberName: String);

Description

[2746] AllowElements

[2747] ToString

[2748] [C#] public bool AllowElements {get; set;} [C++] public: _property bool get_AllowElements( );public: _property void set_AllowElements(bool); [VB] Public Property AllowElements As Boolean [JScript] public function get AllowElements( ): Boolean;public function set AllowElements(Boolean);

Description

[2749] MemberName

[2750] ToString

[2751] [C#] public string MemberName {get; set;} [C++] public: _property String* get_MemberName( );public: _property void set_MemberName(String*); [VB] Public Property MemberName As String [JScript] public function get MemberName( ): String;public function set MemberName(String);

Description

[2752] TypeId

[2753] XmlFormatExtensionPrefixAttribute class (System.Web.Services.Configuration)

[2754] ToString

Description

[2755] XmlFormatExtensionPrefixAttribute

[2756] Example Syntax:

[2757] ToString

[C#] public XmlFormatExtensionPrefixAttribute( ); [C++] public: XmlFormatExtensionPrefixAttribute( ); [VB] Public Sub New( ) [JScript] public function XmlFormatExtensionPrefixAttribute( );

Description

[2758] XmlFormatExtensionPrefixAttribute

[2759] Example Syntax:

[2760] ToString

[2761] [C#] public XmlFormatExtensionPrefixAttribute(string prefix, string ns); [C++] public: XmlFormatExtensionPrefixAttribute(String* prefix, String* ns); [VB] Public Sub New(ByVal prefix As String, ByVal ns As String) [JScript] public function XmlFormatExtensionPrefixAttribute(prefix: String, ns: String);

Description

[2762] Namespace

[2763] ToString

[2764] [C#] public string Namespace {get; set;} [C++] public: _property String* get_Namespace( );public: _property void set_Namespace(String*); [VB] Public Property Namespace As String [JScript] public function get Namespace( ): String;public function set Namespace(String);

Description

[2765] Prefix

[2766] ToString

[C#] public string Prefix {get; set;} [C++]

System.Web.Services.Description

Description

[2767] The System.Web.Services.Description namespace consists of the classes that enable you to publicly describe a Web Service by using the Web Service

[2768] Description Language (WSDL). Each class in the System.Web.Services.Description namespace corresponds to a specific element in the WSDL specification, and the class hierarchy corresponds to the XML structure of a valid WSDL document. For more information about WSDL, see the specification at http://www.w3.org/TR/wsdl/.

[2769] Binding class (System.Web.Services.Description)

Description

[2770] Specifies the concrete data format and protocols used in the Web Service. This class cannot be inherited.

[2771] Constructors:

[2772] Binding

[2773] Example Syntax:

[C#] public Binding( ); [C++] public: Binding( ); [VB] Public Sub New( ) [JScript] public function Binding( );

[2774] Properties:

[2775] Documentation

[2776] Extensions

Description

[2777] Gets the collection of extensibility elements used in the Web Service.

[2778] Name

[C#] public string Name {get; set;} [C++] public: _property String* get_Name( );public: _property void set_Name(String*); [VB] Public Property Name As String [JScript] public function get Name( ): String;public function set Name(String);

Description

[2779] Gets or sets a string value containing the name of the System.Web.Services.Description.Binding.

[2780] Operations

[2781] [C#] public OperationBindingCollection Operations {get;} [C++] public: _property OperationBindingCollection* get_Operations( ); [VB] Public ReadOnly Property Operations As OperationBindingCollection [JScript] public function get Operations( ): OperationBindingCollection;

Description

[2782] Gets the collection of the specifications for data formats and message protocols used in the action supported by the Web Service.

[2783] ServiceDescription

[2784] [C#] public ServiceDescription ServiceDescription {get; } [C++] public: _property ServiceDescription* get_ServiceDescription( ); [VB] Public ReadOnly Property ServiceDescription As ServiceDescription [JScript] public function get ServiceDescription( ): ServiceDescription;

Description

[2785] Gets the System.Web.Services.Description.ServiceDescription instance of which the System.Web.Services.Description.Binding is a member.

[2786] Type

[2787] [C#] public XmlQualifiedName Type {get; set;} [C++] public: _property XmlQualifiedName* get_Type( );public: _property void set Type(XmlQualifiedName*); [VB] Public Property Type As XmlQualifiedName [JScript] public function get Type( ): XmlQualifiedName;public function set Type(XmlQualifiedName);

Description

[2788] Gets or sets a value representing the XML datatype definitions used by the Web Service.

[2789] The default implementation is String.Empty.

[2790] Methods:

[2791] BindingCollection class (System.Web.Services.Description )

[2792] ToString

Description

[2793] Represents a collection of System.Web.Services.Description.Binding elements supported by the Web Service. This class cannot be inherited.

[2794] Count

[2795] InnerList

[2796] Item

[2797] ToString

[2798] System.Web.Services.Description.Binding

Description

[2799] Gets or sets the value of a System.Web.Services.Description.Binding at the specified zero-based index. The zero-based index of the System.Web.Services.Description.Binding whose value is modified or returned.

[2800] Item

[2801] ToString

[C#] public Binding this[string name] {get;} [C++] public: _property Binding* get_Item(String* name); [VB] Public Default ReadOnly Property Item(ByVal name As String) As Binding [JScript] returnValue=BindingCollectionObject.Item(name);

Description

[2802] Gets a System.Web.Services.Description.Binding specified by its Name property. A string value representing the name of the Binding returned.

[2803] List

[2804] Table

[2805] Add

[C#] public int Add(Binding binding); [C++] public: int Add(Binding* binding); [VB] Public Function Add(ByVal binding As Binding) As Integer [JScript] public function Add(binding: Binding): int;

Description

[2806] Adds the specified System.Web.Services.Description.Binding to the end of the System.Web.Services.Description.BindingCollection.

Return Value: Returns the zero-based index where binding has been added. The System.Web.Services.Description.Binding to be added to the collection.

[2807] Contains

[C#] public bool Contains(Binding binding); [C++] public: bool Contains(Binding* binding); [VB] Public Function Contains(ByVal binding As Binding) As Boolean [JScript] public function Contains(binding: Binding): Boolean;

Description

[2808] Gets a value indicating whether the specified System.Web.Services.Description.Binding is a member of the System.Web.Services.Description.BindingCollection.

Return Value: true if binding is a member of the System.Web.Services.Description.BindingCollection; otherwise, false. A System.Web.Services.Description.Binding object.

[2809] CopyTo

[C#] public void CopyTo(Binding[ ] array, int index); [C++] public: void CopyTo(Binding* array[ ], int index); [VB] Public Sub CopyTo(ByVal array( ) As Binding, ByVal index As Integer) [JScript] public function CopyTo(array: Binding[ ], index: int);

Description

[2810] Copies the entire System.Web.Services.Description.BindingCollection to a compatible one-dimensional array of type System.Web.Services.Description.Binding, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.Binding serving as the destination for the copy action. The zero-based index at which to start placing the copied collection.

[2811] GetKey

[C#] protected override string GetKey(object value); [C++] protected: String* GetKey(Object* value); [VB] Overrides Protected Function GetKey(ByVal value As Object) As String [JScript] protected override function GetKey(value: Object): String;

Description

[2812] Returns the name of the System.Web.Services.Description.Binding associated with the value passed by reference. An object for which to return the name of the key.

[2813] IndexOf

[C#] public int IndexOf(Binding binding); [C++] public: int IndexOf(Binding* binding); [VB] Public Function IndexOf(ByVal binding As Binding) As Integer [JScript] public function IndexOf(binding: Binding): int;

Description

[2814] Searches for the specified System.Web.Services.Description.Binding and returns the zero-based index of the first occurrence within the collection.

Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.Binding object.

[2815] Insert

[C#] public void Insert(int index, Binding binding); [C++] public: void Insert(int index, Binding* binding); [VB] Public Sub Insert(ByVal index As Integer, ByVal binding As Binding) [JScript] public function Insert(index: int, binding: Binding);

Description

[2816] Adds the specified System.Web.Services.Description.Binding to the System.Web.Services.Description.BindingCollection at the specified index.

[2817] If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert binding. The System.Web.Services.Description.Binding to be added to the collection.

[2818] Remove

[C#] public void Remove(Binding binding); [C++] public: void Remove(Binding* binding); [VB] Public Sub Remove(ByVal binding As Binding) [JScript] public function Remove(binding: Binding);

Description

[2819] Removes the first occurrence of the specified System.Web.Services.Description.Binding from the System.Web.Services.Description.BindingCollection.

[2820] This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.BindingCollection.Count. A System.Web.Services.Description.Binding object.

[2821] SetParent

[2822] [C#] protected override void SetParent(object value, object parent); [C++] protected: void SetParent(Object* value, Object* parent); [VB] Overrides Protected Sub SetParent(ByVal value As Object, ByVal parent As Object) [JScript] protected override function SetParent(value: Object, parent: Object);

Description

[2823] Sets the parent System.Web.Services.Description.ServiceDescription of a member of System.Web.Services.Description.BindingCollection. An object, of type System.Web.Services.Description.Binding, within the collection. The object, of type System.Web.Services.Description.ServiceDescription, to set as the parent.

[2824] DocumentableItem class (System.Web.Services.Description)

[2825] ToString

Description

[2826] Represents the abstract base class from which several classes in the System.Web.Services.Description namespace are derived.

[2827] Several classes are derived from this class, including: System.Web.Services.Description.BindingSystem.Web.Services.Description.ImportSystem.Web.Services.Description.MessageSystem.Web.Services. Description.MessagePartSystem.Web.Services.Description.OperationSystem.Web.Services.Description.OperationBindingSystem.Web.Services. Description.OperationMessageSystem.Web.Services.Description.PortSystem.Web.Services.Description.PortTypeSystem.Web.Services.Description. ServiceSystem.Web.Services.Description.Types This base class contains only one property, the Documentation property. It represents the text documentation for a specific XML element.

[2828] DocumentableItem

[2829] Example Syntax:

[2830] ToString

[C#] protected DocumentableItem( ); [C++] protected: DocumentableItem( ); [VB] Protected Sub New( ) [JScript] protected function DocumentableItem( );

[2831] Documentation

[2832] ToString

[2833] [C#] public string Documentation {get; set;} [C++] public: _property String* get_Documentation( );public: _property void set_Documentation(String*); [VB] Public Property Documentation As String [JScript] public function get Documentation( ): String;public function set Documentation(String);

Description

[2834] Gets or sets the documentation for the instance of the System.Web.Services.Description.DocumentableItem.

[2835] In a derived class, this property represents the text comments added to an element of the Web Service. The default implementation is String.Empty.

[2836] FaultBinding class (System.Web.Services.Description)

[2837] ToString

Description

[2838] Specifies the format for any error messages that might be output as a result of the operation. This class cannot be inherited.

[2839] FaultBinding

[2840] Example Syntax:

[2841] ToString

[C#] public FaultBinding( ); [C++] public: FaultBinding( ); [VB] Public Sub New( ) [JScript] public function FaultBinding( );

[2842] Documentation

[2843] Extensions

[2844] ToString

Description

[2845] Gets the collection of extensibility elements associated with the System.Web.Services.Description.FaultBinding.

[2846] Name

[2847] OperationBinding

[2848] FaultBindingCollection class (System.Web.Services.Description)

[2849] ToString

Description

[2850] Represents a collection of System.Web.Services.Description.FaultBinding instances. This class cannot be inherited.

[2851] Count

[2852] InnerList

[2853] Item

[2854] ToString

[2855] System.Web.Services.Description.FaultBinding

Description

[2856] Gets or sets the value of a System.Web.Services.Description.FaultBinding at the specified zero-based index. The zero-based index of the System.Web.Services.Description.FaultBinding whose value is modified or returned.

[2857] Item

[2858] ToString

[2859] [C#] public FaultBinding this[string name] {get;} [C++] public: _property FaultBinding* get_Item(String* name); [VB] Public Default ReadOnly Property Item(ByVal name As String) As FaultBinding [JScript] returnValue=FaultBindingCollectionObject.Item(name);

Description

[2860] Gets a System.Web.Services.Description.FaultBinding specified by its System.Web.Services.Description.FaultBinding.Name property. The string value representing the name of the System.Web.Services.Description.FaultBinding returned.

[2861] List

[2862] Table

[2863] Add

[2864] [C#] public int Add(FaultBinding bindingOperationFault); [C++] public: int Add(FaultBinding* bindingOperationFault); [VB] Public Function Add(ByVal bindingOperationFault As FaultBinding) As Integer [JScript] public function Add(bindingOperationFault: FaultBinding): int;

Description

[2865] Adds the specified System.Web.Services.Description.FaultBinding to the end of the System.Web.Services.Description.FaultBindingCollection.

Return Value: Returns the index where bindingOperationFault has been added. The System.Web.Services.Description.FaultBinding to be added to the collection.

[2866] Contains

[2867] [C#] public bool Contains(FaultBinding bindingOperationFault); [C++] public: bool Contains(FaultBinding* bindingOperationFault); [VB] Public Function Contains(ByVal bindingOperationFault As FaultBinding) As Boolean [JScript] public function Contains(bindingOperationFault: FaultBinding) Boolean;

Description

[2868] Gets a value indicating whether the specified System.Web.Services.Description.FaultBinding is a member of the FaultBindingCollection.

Return Value: true if bindingOperationFault is a member of the FaultBindingCollection; otherwise, false. A System.Web.Services.Description.FaultBinding object.

[2869] CopyTo

[2870] [C#] public void CopyTo(FaultBinding[ ] array, int index); [C++] public: void CopyTo(FaultBinding* array[ ], int index); [VB] Public Sub CopyTo(ByVal array( ) As FaultBinding, ByVal index As Integer) [JScript] public function CopyTo(array: FaultBinding[ ], index: int);

Description

[2871] Copies the entire FaultBindingCollection to a compatible one-dimensional array of type System.Web.Services.Description.FaultBinding, starting at the specified zero-based index of the target array. An array of type System.Web.Services.Description.FaultBinding serving as the destination for the copy action. The zero-based index at which to start placing the copied collection.

[2872] GetKey

[C#] protected override string GetKey(object value); [C++] protected: String* GetKey(Object* value); [VB] Overrides Protected Function GetKey(ByVal value As Object) As String [JScript] protected override function GetKey(value: Object): String;

Description

[2873] Returns the name of the System.Web.Services.Description.FaultBinding associated with the value passed by reference. An object for which to return the name.

[2874] IndexOf

[2875] [C#] public int IndexOf(FaultBinding bindingOperationFault); [C++] public: int IndexOf(FaultBinding* bindingOperationFault); [VB] Public Function IndexOf(ByVal bindingOperationFault As FaultBinding) As Integer [JScript] public function IndexOf(bindingOperationFault: FaultBinding): int;

Description

[2876] Searches for the specified System.Web.Services.Description.FaultBinding and returns the zero-based index of the first occurrence within the collection.

Return Value: Returns a 32-bit signed integer. A System.Web.Services.Description.FaultBinding instance.

[2877] Insert

[2878] [C#] public void Insert(int index, FaultBinding bindingOperationFault); [C++] public: void Insert(int index, FaultBinding* bindingOperationFault); [VB] Public Sub Insert(ByVal index As Integer, ByVal bindingOperationFault As FaultBinding) [JScript] public function Insert(index: int, bindingOperationFault: FaultBinding);

Description

[2879] Adds the specified System.Web.Services.Description.FaultBinding to the FaultBindingCollection at the specified zero-based index.

[2880] If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert bindingOperationFault. The System.Web.Services.Description.FaultBinding to be added to the collection.

[2881] Remove

[2882] [C#] public void Remove(FaultBinding bindingOperationFault); [C++] public: void Remove(FaultBinding* bindingOperationFault); [VB] Public Sub Remove(ByVal bindingOperationFault As FaultBinding) [JScript] public function Remove(bindingOperationFault: FaultBinding);

Description

[2883] Removes the first occurrence the specified System.Web.Services.Description.FaultBinding from the FaultBindingCollection.

[2884] This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.FaultBindingCollection.Count. The System.Web.Services.Description.FaultBinding object to be removed from the collection.

[2885] SetParent

[2886] [C#] protected override void SetParent(object value, object parent); [C++] protected: void SetParent(Object* value, Object* parent); [VB] Overrides Protected Sub SetParent(ByVal value As Object, ByVal parent As Object) [JScript] protected override function SetParent(value: Object, parent: Object);

Description

[2887] Sets the parent System.Web.Services.Description.OperationBinding of a member of the FaultBindingCollection instance. An object, of type System.Web.Services.Description.FaultBinding, within the FaultBindingCollection. The object, of type System.Web.Services.Description.OperationBinding, to set as the parent.

[2888] HttpAddressBinding class (System.Web.Services.Description)

[2889] ToString

Description

[2890] Represents an extensibility element added to a System.Web.Services.Description.Port within a Web Service. This class cannot be inherited.

[2891] This class, through its System.Web.Services.Description.HttpAddressBinding.Location property, specifies the base URI for the Web Service. For more information, see.

[2892] HttpAddressBinding

[2893] Example Syntax:

[2894] ToString

[C#] public HttpAddressBinding( ); [C++] public: HttpAddressBinding( ); [VB] Public Sub New( ) [JScript] public function HttpAddressBinding( );

[2895] Handled

[2896] Location

[2897] ToString

Description

[2898] Gets or sets a value representing the URL of the .asmx file containing the methods exposed by the Web Service.

[2899] Parent

[2900] Required

[2901] HttpBinding class (System.Web.Services.Description)

[2902] ToString

Description

[2903] Represents an extensibility element added to a System.Web.Services.Description.Binding within a Web Service. This class cannot be inherited.

[2904] This class specifies that information is to be passed by means of HTTP. For more information about specification of protocols for Web Services, see.

[2905] ToString

[C#] public const string Namespace; [C++] public: const String* Namespace; [VB] Public Const Namespace As String [JScript] public var Namespace: String;

Description

[2906] Specifies the URI (http://schemas.xmlsoap.org/wsdl/http/) for the XML namespace of the HttpBinding class.

[2907] HttpBinding

[2908] Example Syntax:

[2909] ToString

[C#] public HttpBinding( ); [C++] public: HttpBinding( ); [VB] Public Sub New( ) [JScript] public function HttpBinding( );

[2910] Handled

[2911] Parent

[2912] Required

[2913] Verb

[2914] ToString

Description

[2915] Gets or sets a value indicating whether the Http request will be made using the “GET” or “POST” method.

[2916] HttpOperationBinding class (System.Web.Services.Description)

[2917] ToString

Description

[2918] Represents an extensibility element added to an System.Web.Services.Description.OperationBinding within a Web Service. This class cannot be inherited.

[2919] This class specifies how a Web Service passes information by means of HTTP. For more information, see.

[2920] HttpOperationBinding

[2921] Example Syntax:

[2922] ToString

[C#] public HttpOperationBinding( ); [C++] public: HttpOperationBinding( ); [VB] Public Sub New( ) [JScript] public function HttpOperationBinding( );

[2923] Handled

[2924] Location

[2925] ToString

Description

[2926] Gets or sets a value representing the relative URL, within the WSDL document, of the action supported by the HttpOperationBinding.

[2927] Parent

[2928] Required

[2929] HttpUrlEncodedBinding class (System.Web.Services.Description)

[2930] ToString

Description

[2931] Represents an extensibility element added to an System.Web.Services.Description.InputBinding within a Web Service. This class cannot be inherited.

[2932] This class specifies that the incoming data will be in the format “name=value&name value”, encoded from an System.Web.UI.HtmlControls.HtmlForm, whether the value of the HtmlForm's System.Web.UI.HtmlControls.HtmlForm.Method property is POST or GET.

[2933] HttpUrlEncodedBinding

[2934] Example Syntax:

[2935] ToString

[C#] public HttpUrlEncodedBinding( ); [C++] public: HttpUrlEncodedBinding( ); [VB] Public Sub New( ) [JScript] public function HttpUrlEncodedBinding( );

[2936] Handled

[2937] Parent

[2938] Required

[2939] HttpUrlReplacementBinding class (System.Web.Services.Description)

[2940] ToString

Description

[2941] Represents an extensibility element added to an System.Web.Services.Description.InputBinding within a Web Service. It specifies the format for data transmission through HTTP. This class cannot be inherited.

[2942] This class allows users to specify a custom format for data transmission, rather than limiting them to the standard format, “name=value&name=value”, used in HTTP query strings. For example, a developer may decide to use /name,value/name,value or some other custom format instead.

[2943] HttpUrlReplacementBinding

[2944] Example Syntax:

[2945] ToString

[C#] public HttpUrlReplacementBinding( ); [C++] public: HttpUrlReplacementBinding( ); [VB] Public Sub New( ) [JScript] public function HttpUrlReplacementBinding( );

[2946] Handled

[2947] Parent

[2948] Required

[2949] Import class (System.Web.Services.Description)

[2950] ToString

Description

[2951] Associates an XML namespace with a document location. This class cannot be inherited.

[2952] Many of the tags in the WSDL schema can contain the tag. It allows the separation of different elements of the Web Service into different documents, which can then be imported as needed.

[2953] Import

[2954] Example Syntax:

[2955] ToString

[C#] public Import( ); [C++] public: Import( ); [VB] Public Sub New( ) [JScript] public function Import( );

[2956] Documentation

[2957] Location

[2958] ToString

Description

[2959] Gets or sets a reference to the XML Location attribute of the System.Web.Services.Description.Import instance.

[2960] Namespace

[2961] ToString

[2962] [C#] public string Namespace {get; set;} [C++] public: _property String* get_Namespace( );public: _property void set_Namespace(String*); [VB] Public Property Namespace As String [JScript] public function get Namespace( ): String;public function set Namespace(String);

Description

[2963] Gets or sets a reference to the XML Namespace of the System.Web.Services.Description.Import instance.

[2964] ServiceDescription

[2965] ToString

[2966] [C#] public ServiceDescription ServiceDescription {get;} [C++] public: _property ServiceDescription* get_ServiceDescription( ); [VB] Public ReadOnly Property ServiceDescription As ServiceDescription [JScript] public function get ServiceDescription( ): ServiceDescription;

Description

[2967] Gets a reference to the System.Web.Services.Description.ServiceDescription of which the Import instance is a member.

[2968] ImportCollection class (System.Web.Services.Description)

[2969] ToString

Description

[2970] Provides a collection of System.Web.Services.Description.Import instances representing documents to be imported into the Web Service. This class cannot be inherited.

[2971] Count

[2972] InnerList

[2973] Item

[2974] ToString

Description

[2975] Gets or sets the value of an System.Web.Services.Description.Import at the specified zero-based index. The zero-based index of the Import whose value is modified or returned.

[2976] List

[2977] Table

[2978] Add

[C#] public int Add(Import import); [C++] public: int Add(Import* import); [VB] Public Function Add(ByVal import As Import) As Integer [JScript] public function Add(import: Import): int;

Description

[2979] Adds the specified System.Web.Services.Description.Import instance to the end of the System.Web.Services.Description.ImportCollection.

Return Value: Returns the index where import has been added. The System.Web.Services.Description.Import to be added to the collection.

[2980] Contains

[C#] public bool Contains(Import import); [C++] public: bool Contains(Import* import); [VB] Public Function Contains(ByVal import As Import) As Boolean [JScript] public function Contains(import: Import): Boolean;

Description

[2981] Gets a value indicating whether the specified System.Web.Services.Description.Import instance is a member of the System.Web.Services.Description.ImportCollection.

Return Value: true if import is a member of the System.Web.Services.Description.ImportCollection; otherwise, false. An System.Web.Services.Description.Import object.

[2982] CopyTo

[C#] public void CopyTo(Import[ ] array, int index); [C++] public: void CopyTo(Import* array[ ], int index); [VB] Public Sub CopyTo(ByVal array( ) As Import, ByVal index As Integer) [JScript] public function CopyTo(array: Import[ ], index: int);

Description

[2983] Copies the entire ImportCollection to a compatible one-dimensional array of type System.Web.Services.Description.Import, starting at the specified zero-based index of the target array. The destination array, of type System.Web.Services.Description.Import. The zero-based index at which to start placing the copied collection.

[2984] IndexOf

[C#] public int IndexOf(Import import); [C++] public: int IndexOf(Import* import); [VB] Public Function IndexOf(ByVal import As Import) As Integer [JScript] public function IndexOf(import: Import): int;

Description

[2985] Searches for the specified System.Web.Services.Description.Import and returns the zero-based index of the first occurrence within the collection.

Return Value: Returns a 32-bit signed integer. An System.Web.Services.Description.Import object.

[2986] Insert

[C#] public void Insert(int index, Import import); [C++] public: void Insert(int index, Import* import); [VB] Public Sub Insert(ByVal index As Integer, ByVal import As Import) [JScript] public function Insert(index: int, import: Import);

Description

[2987] Adds the specified System.Web.Services.Description.Import instance to the ImportCollection at the specified index.

[2988] If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. The zero-based index at which to insert import. The System.Web.Services.Description.Import to be added to the collection.

[2989] Remove

[C#] public void Remove(Import import); [C++] public: void Remove(Import* import); [VB] Public Sub Remove(ByVal import As Import) [JScript] public function Remove(import: Import);

Description

[2990] Removes the first occurrence of the specified System.Web.Services.Description.Import from the ImportCollection.

[2991] This method performs a linear search; therefore, the average execution time is proportional to System.Web.Services.Description.ImportCollection.Count. An System.Web.Services.Description.Import object.

[2992] SetParent

[2993] [C#] protected override void SetParent(object value, object parent); [C++] protected: void SetParent(Object* value, Object* parent); [VB] Overrides Protected Sub SetParent(ByVal value As Object, ByVal parent As Object) [JScript] protected override function SetParent(value: Object, parent: Object);

Description

[2994] Sets the parent System.Web.Services.Description.ServiceDescription of the specified System.Web.Services.Description.Import. An object, of type System.Web.Services.Description.Import, within the collection. The object, of type System.Web.Services.Description.ServiceDescription, to set as the parent.

[2995] InputBinding class (System.Web.Services.Description)

[2996] ToString

Description

[2997] Provides a set of specifications for data formats and protocols used by the Web Service for input messages. This class cannot be inherited.

[2998] InputBinding

[2999] Example Syntax:

[3000] ToString

[C#] public InputBinding( ); [C++] public: InputBinding( ); [VB] Public Sub New( ) [JScript] public function InputBinding( );

[3001] Documentation

[3002] Extensions

[3003] ToString

Description

[3004] Gets the System.Web.Services.Description.ServiceDescriptionFormatExtensionCollect ion associated with the InputBinding instance.

[3005] Name

[3006] OperationBinding

[3007] Message class (System.Web.Services.Description)

[3008] ToString

Description

[3009] Defines in the abstract the content, either document-oriented or procedure-oriented, of data passed by the Web Service. This class cannot be inherited.

[3010] Message

[3011] Example Syntax:

[3012] ToString

[C#] public Message( ); [C++] public: Message( ); [VB] Public Sub New( ) [JScript] public function Message( );

[3013] Documentation

[3014] Name

[3015] ToString

Description