<class namespace="WebCntxt">IWebPageInfo</class> describes a Web page in a WebSnap application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="WebCntxt">IWebPageInfo</class> to obtain information about a Web page, including its page name, page title, descriptive text, publish status, and access rights. This information is taken from a TWebPageInfo object that is stored with the Web page module factory.</para>
<para>VCL Method declarations that use <class namespace="WebCntxt">IWebPageInfo</class> use the _di_<class namespace="WebCntxt">IWebPageInfo</class> type instead. This type is a DelphiInterface wrapper around the <class namespace="WebCntxt">IWebPageInfo</class> interface:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Denotes the logical name for the Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebPageInfo">PageName</property> to determine the name of the Web page. This name is used to identify the page in server-side scripts, and as the pathinfo portion of the URL for the page when the PageIsPublished property is true.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.PageHREF">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies the HREF to use for references to the associated Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebPageInfo">PageHREF</property> to obtain the HTTP path string that should be inserted in HTML code to create a hypertext link to the associated Web page.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.PageTitle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the title that appears on the Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebPageInfo">PageTitle</property> to determine the title that appears on the Web page when viewed from a user's browser. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes the Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebPageInfo">PageDescription</property> to obtain a brief description of the Web page.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the WebSnap application automatically displays the Web page in response to request messages where the pathinfo portion of the target URL matches PageName. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebPageInfo">PageIsPublished</property> to determine whether the page dispatcher (TPageDispatcher) automatically calls on the associated Web page module when it receives HTTP request messages that address this Web page by name. HTTP request messages address a Web page when the pathinfo portion of their target URL matches the value of the PageName property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When IsPublished is false, the WebSnap application must explicitly retrieve the content for the Web page and add it to a response message.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.LoginRequired">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether callers must log in before accessing this Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebPageInfo">LoginRequired</property> to determine whether users must log in before they can access this Web page. The application can overrule the <property namespace="WebCntxt" class="IWebPageInfo">LoginRequired</property> property by supplying an OnIs<property namespace="WebCntxt" class="IWebPageInfo">LoginRequired</property> event handler to the page dispatcher.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.HasViewAccess">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the current user has access rights to view the Web page.</para>
<property namespace="WebCntxt" class="IWebPageInfo">HasViewAccess</property> is true if the current end user has view rights for the associated Web page, false otherwise.</para>
<class namespace="WebCntxt">IWebEndUser</class> provides access information about the current end user in a WebSnap application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="WebCntxt">IWebEndUser</class> to obtain information about the current end user, such as the user name, user ID, and whether the user is logged in. In addition to properties that provide information about the current end user, <class namespace="WebCntxt">IWebEndUser</class> has methods to log in an end user. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">End user adapter components such as TEndUserAdapter and TEndUserSessionAdapter implement the <class namespace="WebCntxt">IWebEndUser</class> interface. If a WebSnap application includes an end user adapter, you can access its <class namespace="WebCntxt">IWebEndUser</class> interface by reading the EndUser property of the Web context.</para>
<para>In C++, method declarations that use <class namespace="WebCntxt">IWebEndUser</class> use the _di_<class namespace="WebCntxt">IWebEndUser</class> type instead. This type is a DelphiInterface wrapper around the <class namespace="WebCntxt">IWebEndUser</class> interface:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the current user has access rights to execute Web pages or adapters associated with a specified access string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="IWebEndUser">HasExecuteRights</method> to determine whether the current end user is authorized to execute Web pages or adapters whose ViewRights property is the value specified by ARights. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Typically, the end user adapter that implements this interface implements <method namespace="WebCntxt" class="IWebEndUser">HasExecuteRights</method> by checking the AccessRightsStrings property of the entry for this end user in a TWebUserList component. Note that in this case, the end user must be logged in before <method namespace="WebCntxt" class="IWebEndUser">HasExecuteRights</method> can determine the user's access rights.</para>
</comments>
</member>
<member name="M:WebCntxt.WebCntxt.HasViewRights">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the current user has access rights to view Web pages or adapters associated with a specified access string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="IWebEndUser">HasViewRights</method> to determine whether the current end user is authorized to view Web pages or adapters whose ViewRights property is the value specified by ARights. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Typically, the end user adapter that implements this interface implements <method namespace="WebCntxt" class="IWebEndUser">HasViewRights</method> by checking the AccessRightsStrings property of the entry for this end user in a TWebUserList component. Note that in this case, the end user must be logged in before <method namespace="WebCntxt" class="IWebEndUser">HasViewRights</method> can determine the user's access rights.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the current user has access rights to modify Web pages or adapters associated with a specified access string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="IWebEndUser">HasModifyRights</method> to determine whether the current end user is authorized to modify Web pages or adapters whose ViewRights property is the value specified by ARights. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Typically, the end user adapter that implements this interface implements <method namespace="WebCntxt" class="IWebEndUser">HasModifyRights</method> by checking the AccessRightsStrings property of the entry for this end user in a TWebUserList component. Note that in this case, the end user must be logged in before <method namespace="WebCntxt" class="IWebEndUser">HasModifyRights</method> can determine the user's access rights.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates the Web page for logging in users.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="IWebEndUser">ProduceLoginPage</method> to generate a Web page for logging in users.</para>
<method namespace="WebCntxt" class="IWebEndUser">ProduceLoginPage</method> returns true if it generates a login form page and updates the current response message so that it will be displayed to the user. <method namespace="WebCntxt" class="IWebEndUser">ProduceLoginPage</method> returns false if the end user adapter is unable to generate a login page.</para>
</comments>
</member>
<member name="M:WebCntxt.WebCntxt.LogIn">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Logs in a specified user.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="IWebEndUser">LogIn</method> to record a user as logged in. Typically, <method namespace="WebCntxt" class="IWebEndUser">LogIn</method> is called in response to a message from the login page that ProduceLoginPage generates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">UserID is the identifier of the user that logged in. It is the value of the UserID property of the entry for the user in a WebUserList component, or, in applications that implement their own login scheme, any other Variant that identifies an end user.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.DisplayName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the name of the end user as it should be used for display in Web pages.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebEndUser">DisplayName</property> to obtain a string that can be added to Web pages to refer to the current user.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.LoggedIn">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the current user is logged in.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebEndUser">LoggedIn</property> to determine whether the current user has logged in to the WebSnap application. By logging in, a caller can be identified as one of the users that a TWebUserList component lists.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Once the user has logged in, the HasViewRights, HasExecuteRights, and HasModifyRights methods can be used to determine whether the user is authorized to view, execute actions, and modify data on restricted Web pages.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To log in a user that is not logged in, call the ProduceLoginPage method to display a login Web page. That page should allow the user to provide some sort of UserID, which can then be used to log the user in by a call to the LogIn method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the action component for the login form.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebEndUser">LoginFormAction</property> to access the login form action component. The login form action component can be called from server-side scripts to display a login form Web page. </para>
<para>To display the login form Web page using the <property namespace="WebCntxt" class="IWebEndUser">IWebEndUser</property> interface (rather than from a server-side script), call the ProduceLoginPage method.</para>
</note>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.LogoutAction">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the action component for logging a user out.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebEndUser">LogoutAction</property> to access the logout action component. The logout action component can be called from server-side scripts to perform any necessary tasks when the user logs out. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the end user adapter that implements this interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="IWebEndUser">EndUserAdapter</property> to obtain access to the end user adapter. This is the component that implements this interface. Typically, it is a T<property namespace="WebCntxt" class="IWebEndUser">EndUserAdapter</property> or TEndUserSessionAdapter instance.</para>
<class namespace="WebCntxt">TAbstractWebContext</class> is the base class for objects that represent the current state of a WebSnap application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A Web context stores information about the components that are available in a WebSnap application and about the current request that is being processed. Applications do not create instances of the Web context. Rather, they access the current Web context object by calling the global WebContext function.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the application module instance.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TAbstractWebContext">FindApplicationModule</method> to access the main Web module in the WebSnap application. <method namespace="WebCntxt" class="TAbstractWebContext">FindApplicationModule</method> returns a reference to the module that the WebSnap application wizard creates. This can be an instance of TWebAppPageModule or TWebAppDataModule.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Application module is the module that holds the application-wide components such as the page dispatcher, end user adapter, application adapter, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WebModuleContext is a context object that holds design-time information about the application modules. It is only used at design time. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns an instance of a Web module, given its class reference.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TAbstractWebContext">FindModuleClass</method> to obtain a reference to a Web module given its class reference. If an instance of the specified class already exists, <method namespace="WebCntxt" class="TAbstractWebContext">FindModuleClass</method> returns that instance. Otherwise, if the specified class represents a registered Web module class, <method namespace="WebCntxt" class="TAbstractWebContext">FindModuleClass</method> creates an instance of the specified class and returns the new instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AClass is the class reference to a registered Web module class. This class is declared in code that the Web page module wizard or Web data module wizard generates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns an instance of a Web module, given its class name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TAbstractWebContext">FindModuleName</method> to obtain a reference to a Web module given the name of its implementation class. If an instance of the specified class already exists, <method namespace="WebCntxt" class="TAbstractWebContext">FindModuleName</method> returns that instance. Otherwise, if the specified class represents a registered Web module class, FindModuleClass creates an instance of the specified class and returns the new instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AClass is the name of a registered Web module class. This class is declared in code that the Web page module wizard or Web data module wizard generates.</para>
</comments>
</member>
<member name="M:WebCntxt.WebCntxt.FindPage">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Retrieves a Web page module given its name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TAbstractWebContext">FindPage</method> to obtain an instance of a registered Web page module given its name. If an instance of the specified Web page module already exists, <method namespace="WebCntxt" class="TAbstractWebContext">FindPage</method> returns that instance. Otherwise, if the named Web page module is registered, <method namespace="WebCntxt" class="TAbstractWebContext">FindPage</method> creates an instance of the module and returns the new instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">APage is the name of the desired Web page module. The name is specified using the Web page module wizard, and forms the basis of the Web page module's class name. Thus, a Web page module with a name MyPage has the class name TMyPage.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AOptions is a set of options that can limit the page modules that <method namespace="WebCntxt" class="TAbstractWebContext">FindPage</method> considers. For any option included in this set, <method namespace="WebCntxt" class="TAbstractWebContext">FindPage</method> only considers Web page modules that have the corresponding attribute.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AComponent returns the instance of the specified Web page module.</para>
<method namespace="WebCntxt" class="TAbstractWebContext">FindPage</method> returns true if it can find or create an instance of the specified Web page module, false otherwise.</para>
</comments>
</member>
<member name="M:WebCntxt.WebCntxt.FindPageInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Retrieves a Web page information object given the name of the corresponding Web page module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TAbstractWebContext">FindPageInfo</method> to obtain the Web page information object for a Web page module. <method namespace="WebCntxt" class="TAbstractWebContext">FindPageInfo</method> retrieves the information object that is registered for the Web page module that has a specified name. The Web page information object describes the characteristics of the Web page, including its name, title, HREF, view access string, an indication of whether users must log in to access the page, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">APage is the name of the desired Web page module. The name is specified using the Web page module wizard, and forms the basis of the Web page module's class name. Thus, a Web page module with a name MyPage has the class name TMyPage.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AOptions is a set of options that can limit the page modules that <method namespace="WebCntxt" class="TAbstractWebContext">FindPageInfo</method> considers. For any option included in this set, <method namespace="WebCntxt" class="TAbstractWebContext">FindPageInfo</method> only considers Web page modules that have the corresponding attribute.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">APageInfo returns the Web page information object that describes the characteristics of the specified Web page module, and that provides access to the factory object that you can use to create instances of the Web page module.</para>
<method namespace="WebCntxt" class="TAbstractWebContext">FindPageInfo</method> returns false if it can't return a value for the APageInfo parameter. <method namespace="WebCntxt" class="TAbstractWebContext">FindPageInfo</method> returns true if it locates a registered Web page module with the specified name and attributes. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Retrieves the Web page information object for a specified class of Web module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TAbstractWebContext">FindDefaultPageInfo</method> to obtain the Web page information object for a Web module. <method namespace="WebCntxt" class="TAbstractWebContext">FindDefaultPageInfo</method> retrieves the information object that is registered for the Web page module class specified by AComponentClass. The Web page information object describes the characteristics of the Web page, including its name, title, HREF, view access string, an indication of whether users must log in to access the page, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AComponentClass is a class reference to the class that implements the Web page module. This class is declared in code that the Web page module wizard generates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">APageInfo returns the Web page information object that describes the characteristics of the specified Web page module, and that provides access to the factory object that you can use to create instances of the Web page module.</para>
<method namespace="WebCntxt" class="TAbstractWebContext">FindDefaultPageInfo</method> returns false if it can't return a value for the APageInfo parameter. <method namespace="WebCntxt" class="TAbstractWebContext">FindDefaultPageInfo</method> returns true if it locates a registered Web page module for the class specified by AComponentClass. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns an instance of a Web data module, given its class name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TAbstractWebContext">FindVariableContainer</method> to obtain a reference to a Web data module given the name of its implementation class. If an instance of the specified class already exists, <method namespace="WebCntxt" class="TAbstractWebContext">FindVariableContainer</method> returns that instance. Otherwise, if the specified class represents a registered Web module class, <method namespace="WebCntxt" class="TAbstractWebContext">FindVariableContainer</method> creates an instance of the specified class and returns the new instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AIdent is the name of a registered Web data module class. This class is declared in code that the Web data module wizard generates.</para>
</comments>
</member>
<member name="M:WebCntxt.WebCntxt.Destroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Frees an instance of <method namespace="WebCntxt" class="TAbstractWebContext">TAbstractWebContext</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not free the global Web context object. This object is automatically maintained by the WebSnap application.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="WebCntxt" class="TAbstractWebContext">TAbstractWebContext</method> destructor unregisters itself with the global WebContext function so that the WebContext function never returns a Web context that no longer exists.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.Request">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the current HTTP request that the application is handling.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="TAbstractWebContext">Request</property> to obtain information about the current HTTP request message. The request object provides access to the headers of the request message, as well as the content of the message.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.Response">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the current HTTP response that the application is assembling.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="TAbstractWebContext">Response</property> to obtain information about or add to the response message that the application builds as a reply to the message that the Request property specifies. The response object provides access to the headers of the response message, as well as the content of the message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the adapter request object that manages access to the current request.</para>
<property namespace="WebCntxt" class="TAbstractWebContext">AdapterRequest</property> is the interface of the object that adapters use to obtain information about the current HTTP request message. The adapter request object obtains its information from the TWebRequest object that is the value of the Request property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the adapter response object that manages access to the current response.</para>
<property namespace="WebCntxt" class="TAbstractWebContext">AdapterResponse</property> is the interface of the object that adapters use to obtain information about the current HTTP response message. The adapter response object obtains its information from the TWebResponse object that is the value of the Response property.</para>
<para>In C++, you can generally obtain an IActionResponse interface from this interface.</para>
</note>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.Session">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the current Web session.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="WebCntxt" class="TAbstractWebContext">Session</property> to get or set information about the current session. <property namespace="WebCntxt" class="TAbstractWebContext">Session</property>s store information about an end user that is needed for a short period of time. This can be used for such tasks as login/logout support, recording user preferences, and so on.</para>
<para>If you want to use a session to store end user information, the WebSnap application should include a T<property namespace="WebCntxt" class="TAbstractWebContext">Session</property>sService component.</para>
</note>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.WebModules">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists all the Modules in the WebSnap application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="WebCntxt" class="TAbstractWebContext">WebModules</property> to access one of the Web modules that make up the WebSnap application. <property namespace="WebCntxt" class="TAbstractWebContext">WebModules</property> lists all of the currently instantiated Web modules. It also provides access to the factory objects for all Web modules in the application, including those that are not yet instantiated.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.PageCount">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of registered Web pages available in the WebSnap application.</para>
<property namespace="WebCntxt" class="TAbstractWebContext">PageCount</property> indicates the number of entries in the Pages property array. Use this value as an upper bound for the index when iterating over all the pages in the WebSnap application.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.Pages">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the page information interfaces of the registered Web pages available in the WebSnap application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="WebCntxt" class="TAbstractWebContext">Pages</property> to obtain an IWebPageInfo interface for a registered Web page module. The IWebPageInfo interface describes the characteristics of a Web page, including its name, title, HREF, description, an indication of whether users must log in to access the page, an indication of whether the current user has access rights to view the page, and so on.</para>
<property namespace="WebCntxt" class="TAbstractWebContext">Pages</property> provides indexed access to page information interfaces. To access the information about a Web page given its name, use the FindPageInfo method instead. To access the information given the class of the Web page module, use the FindDefaultPageInfo method instead. To access the page module itself (rather than the page information interface), use the WebModules property instead.</para>
</comments>
</member>
<member name="P:WebCntxt.WebCntxt.EndUser">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to information about the end user that sent the current request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="WebCntxt" class="TAbstractWebContext">EndUser</property> to obtain information about the caller that sent the current request. You can use the IWeb<property namespace="WebCntxt" class="TAbstractWebContext">EndUser</property> interface to determine whether the end user has logged in, whether the user has access rights to perform specified operations on pages that have a specified access string, the display name for the end user, and so on.</para>
<property namespace="WebCntxt" class="TAbstractWebContext">EndUser</property> is nil (Delphi) or NULL (C++) if the WebSnap application does not include an end user adapter such as T<property namespace="WebCntxt" class="TAbstractWebContext">EndUser</property>Adapter or T<property namespace="WebCntxt" class="TAbstractWebContext">EndUser</property>SessionAdapter.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the Web page module that is producing content to respond to the current request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="WebCntxt" class="TAbstractWebContext">DispatchedPageName</property> to determine the Web page module that is handling the current HTTP request message. Although this is typically the same as the page that the RequestedPageName property specifies, it can differ if the request was redirected to another Web page or if its use was delayed because the caller had not yet logged in. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the name of the Web page module to which the current request is addressed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the page dispatcher receives an HTTP request message, it sets <property namespace="WebCntxt" class="TAbstractWebContext">RequestedPageName</property> to the name of the target Web page module. This is taken from the pathinfo portion of the request message's target URL.</para>
<para>There is no guarantee that <property namespace="WebCntxt" class="TAbstractWebContext">RequestedPageName</property> refers to a registered Web page module, because this property is set before the dispatcher verifies that the requested page exists.</para>
<class namespace="WebCntxt">TWebContext</class> represents the current state of a WebSnap application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A Web context stores information about the components that are available in a WebSnap application and about the current request that is being processed. Applications do not create instances of the Web context. Rather, they access the current Web context object by calling the global WebContext function.</para>
<class namespace="WebCntxt">TWebContext</class> provides the implementation of the abstract or (in C++ terminology) pure virtual methods introduced by its immediate ancestor, TAbstractWebContext.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the application module instance.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TWebContext">FindApplicationModule</method> to access the main Web module in the WebSnap application. <method namespace="WebCntxt" class="TWebContext">FindApplicationModule</method> returns a reference to the module that the WebSnap application wizard creates. This can be an instance of TWebAppPageModule or TWebAppDataModule.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Application module is the module that holds the application-wide components such as the page dispatcher, end user adapter, application adapter, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WebModuleContext is a context object that holds design-time information about the application modules. It is only used at design time. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns an instance of a Web module, given its class reference.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TWebContext">FindModuleClass</method> to obtain a reference to a Web module given its class reference. If an instance of the specified class already exists, <method namespace="WebCntxt" class="TWebContext">FindModuleClass</method> returns that instance. Otherwise, if the specified class represents a registered Web module class, <method namespace="WebCntxt" class="TWebContext">FindModuleClass</method> creates an instance of the specified class and returns the new instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AClass is the class reference to a registered Web module class. This class is declared in code that the Web page module wizard or Web data module wizard generates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns an instance of a Web module, given its class name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TWebContext">FindModuleName</method> to obtain a reference to a Web module given the name of its implementation class. If an instance of the specified class already exists, <method namespace="WebCntxt" class="TWebContext">FindModuleName</method> returns that instance. Otherwise, if the specified class represents a registered Web module class, FindModuleClass creates an instance of the specified class and returns the new instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AClass is the name of a registered Web module class. This class is declared in code that the Web page module wizard or Web data module wizard generates.</para>
</comments>
</member>
<member name="M:WebCntxt.WebCntxt.FindPage">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Retrieves a Web page module given its name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TWebContext">FindPage</method> to obtain an instance of a registered Web page module given its name. If an instance of the specified Web page module already exists, <method namespace="WebCntxt" class="TWebContext">FindPage</method> returns that instance. Otherwise, if the named Web page module is registered, <method namespace="WebCntxt" class="TWebContext">FindPage</method> creates an instance of the module and returns the new instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">APage is the name of the desired Web page module. The name is specified using the Web page module wizard, and forms the basis of the Web page module's class name. Thus, a Web page module with a name MyPage has the class name TMyPage.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AOptions is a set of options that can limit the page modules that <method namespace="WebCntxt" class="TWebContext">FindPage</method> considers. For any option included in this set, <method namespace="WebCntxt" class="TWebContext">FindPage</method> only considers Web page modules that have the corresponding attribute.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AComponent returns the instance of the specified Web page module.</para>
<method namespace="WebCntxt" class="TWebContext">FindPage</method> returns true if it can find or create an instance of the specified Web page module, false otherwise.</para>
</comments>
</member>
<member name="M:WebCntxt.WebCntxt.FindPageInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Retrieves a Web page information object given the name of the corresponding Web page module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TWebContext">FindPageInfo</method> to obtain the Web page information object for a Web page module. <method namespace="WebCntxt" class="TWebContext">FindPageInfo</method> retrieves the information object that is registered for the Web page module that has a specified name. The Web page information object describes the characteristics of the Web page, including its name, title, HREF, view access string, an indication of whether users must log in to access the page, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">APage is the name of the desired Web page module. The name is specified using the Web page module wizard, and forms the basis of the Web page module's class name. Thus, a Web page module with a name MyPage has the class name TMyPage.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AOptions is a set of options that can limit the page modules that <method namespace="WebCntxt" class="TWebContext">FindPageInfo</method> considers. For any option included in this set, <method namespace="WebCntxt" class="TWebContext">FindPageInfo</method> only considers Web page modules that have the corresponding attribute.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">APageInfo returns the Web page information object that describes the characteristics of the specified Web page module, and that provides access to the factory object that you can use to create instances of the Web page module.</para>
<method namespace="WebCntxt" class="TWebContext">FindPageInfo</method> returns false if it can't return a value for the APageInfo parameter. <method namespace="WebCntxt" class="TWebContext">FindPageInfo</method> returns true if it locates a registered Web page module with the specified name and attributes. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Retrieves the Web page information object for a specified class of Web module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TWebContext">FindDefaultPageInfo</method> to obtain the Web page information object for a Web module. <method namespace="WebCntxt" class="TWebContext">FindDefaultPageInfo</method> retrieves the information object that is registered for the Web page module class specified by AComponentClass. The Web page information object describes the characteristics of the Web page, including its name, title, HREF, view access string, an indication of whether users must log in to access the page, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AComponentClass is a class reference to the class that implements the Web page module. This class is declared in code that the Web page module wizard generates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">APageInfo returns the Web page information object that describes the characteristics of the specified Web page module, and that provides access to the factory object that you can use to create instances of the Web page module.</para>
<method namespace="WebCntxt" class="TWebContext">FindDefaultPageInfo</method> returns false if it can't return a value for the APageInfo parameter. <method namespace="WebCntxt" class="TWebContext">FindDefaultPageInfo</method> returns true if it locates a registered Web page module for the class specified by AComponentClass. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns an instance of a Web data module, given its class name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="WebCntxt" class="TWebContext">FindVariableContainer</method> to obtain a reference to a Web data module given the name of its implementation class. If an instance of the specified class already exists, <method namespace="WebCntxt" class="TWebContext">FindVariableContainer</method> returns that instance. Otherwise, if the specified class represents a registered Web module class, <method namespace="WebCntxt" class="TWebContext">FindVariableContainer</method> creates an instance of the specified class and returns the new instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AIdent is the name of a registered Web data module class. This class is declared in code that the Web data module wizard generates.</para>
<method namespace="WebCntxt" class="TWebContext">Create</method>s an initializes an instance of <method namespace="WebCntxt" class="TWebContext">TWebContext</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <method namespace="WebCntxt" class="TWebContext">TWebContext</method>. WebSnap applications create a global Web context automatically to represent the current state of the application. To access this global Web context object, use the global WebContext function.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="WebCntxt" class="TWebContext">TWebContext</method> constructor registers itself with the global WebContext function so that the application can access the Web context using that function, and initializes the properties of the Web context to the values passed in as parameters.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AWebModuleList is the component that manages the Web modules in the application. It becomes the value of the WebModules property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ARequest is the current HTTP request message. It becomes the value of the Request property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AResponse is the current response object that the application is filling out. It becomes the value of the Response property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ASession is the Session object associated with ARequest. It becomes the value of the Session property.</para>
</comments>
</member>
<member name="M:WebCntxt.WebCntxt.Destroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Frees an instance of <method namespace="WebCntxt" class="TWebContext">TWebContext</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not free the global Web context object. This object is automatically maintained by the WebSnap application.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="WebCntxt" class="TWebContext">TWebContext</method> destructor unregisters itself with the global WebContext function so that the WebContext function never returns a Web context that no longer exists.</para>
<class namespace="WebCntxt">TAbstractAdapterRequest</class> is the base class for the object that adapters use to obtain information about the current HTTP request message. An application interacts with an adapter request object through interfaces implemented by various descendants of <class namespace="WebCntxt">TAbstractAdapterRequest</class>. These descendant classes are considered internal to WebSnap and are not documented.</para>
<class namespace="WebCntxt">TAbstractAdapterResponse</class> is the base class for the object that adapters use to obtain information about the current HTTP response message. An application interacts with an adapter response object through interfaces implemented by various descendants of <class namespace="WebCntxt">TAbstractAdapterResponse</class>. These descendant classes are considered internal to WebSnap and are not documented.</para>
</comments>
</member>
<member name="M:WebCntxt.WebContext">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the current Web context</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the <routine namespace="WebCntxt">WebContext</routine> function to obtain a reference to the global Web context. This object stores information about the components that are available in the Web application as well as about the current request that is being processed. </para>
<class namespace="Sockets">ESocketError</class> is the exception class for failures in initializing or shutting down the socket support layer for the Sockets unit.</para>
<class namespace="Sockets">ESocketError</class> is <condition language="Delphi">raised</condition>
<condition language="CBuilder">thrown</condition> if the Sockets unit can't properly initialize or shut down. This unit is required for applications that use TTcpClient, TTcpServer, TUdpSocket, TRawSocket, or other TIpSocket descendants.</para>
<class namespace="Sockets">TBaseSocket</class> encapsulates local operations on file descriptors<condition language="CBuilder">.</condition>
</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <class namespace="Sockets">TBaseSocket</class> component encapsulates local operations on files descriptors, which are objects that a program uses to read from or write to an open file, or open a network socket or a variety of other devices.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Sockets">TBaseSocket</class>. Use <class namespace="Sockets">TBaseSocket</class> as a base class when declaring non-visual components that can appear on the component palette and be used in the form designer. Properties and methods of <class namespace="Sockets">TBaseSocket</class> provide basic behavior that descendant classes inherit as well as behavior that components can override to customize their behavior.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.MapDomain">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Maps the domain.</para>
<method namespace="Sockets" class="TBaseSocket">MapDomain</method> maps the socket domain to an integer based on the value supplied by the Domain property.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.MapSockType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Maps the socket type.</para>
<method namespace="Sockets" class="TBaseSocket">MapSockType</method> maps the socket type to an integer based on the value supplied by the SockType property.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.PeekBuf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads the buffer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TBaseSocket">PeekBuf</method> to make a copy of data waiting in the socket buffer. Use buf to assign a variable to the buffer, and use bufsize to set the size of the buffer to be copied. <method namespace="Sockets" class="TBaseSocket">PeekBuf</method> only copies, but does not otherwise affect the contents of the buffer.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.ReceiveBuf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads data buffers of size bufsize to the socket.</para>
<method namespace="Sockets" class="TBaseSocket">Receiveln</method> reads a delimited chunk of data from the socket. The delimeter cannot be part of the character set. <method namespace="Sockets" class="TBaseSocket">Receiveln</method> fills the buffer until it reaches the delimeter.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.Select">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Tests for socket activity.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TBaseSocket">Select</method> to test for socket activity. <method namespace="Sockets" class="TBaseSocket">Select</method> indicates whether there is any data on the socket waiting to be sent or whether an error condition exists.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The parameter TimeOut is the time-out value. The socket will wait for activity up to TimeOut milliseconds before returning. If t is not explicitly specified, the default value is zero. If t is any negative number the socket will be blocked. It will wait for activity indefinitely, which can be useful for servers.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.SendBuf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes data buffers of size bufsize from the socket.</para>
<method namespace="Sockets" class="TBaseSocket">Sendln</method> sends a delimited chunk of data to the socket. The delimeter cannot be part of the character set. <method namespace="Sockets" class="TBaseSocket">Sendln</method> fills the buffer until it reaches the delimeter.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.SendStream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes a stream of data to the socket.</para>
<method namespace="Sockets" class="TBaseSocket">SendStream</method> sends a stream of data to the socket.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.WaitForData">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Waits up to TimeOut milliseconds for the socket connection to be ready to transfer data.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TBaseSocket">WaitForData</method> to ensure that the socket connection is ready to read or write information. <method namespace="Sockets" class="TBaseSocket">WaitForData</method> returns true if the socket connection is ready. <method namespace="Sockets" class="TBaseSocket">WaitForData</method> returns false if the socket connection is not ready after t (time-out) milliseconds elapse.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TBaseSocket">WaitForData</method> before reading or writing information over the socket connection. Otherwise, ReceiveBuf, Receiveln, SendBuf, and Sendln method calls may time out before any data is transferred.</para>
<method namespace="Sockets" class="TBaseSocket">Create</method>s an instance of <method namespace="Sockets" class="TBaseSocket">TBaseSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TBaseSocket">Create</method> to instantiate a <method namespace="Sockets" class="TBaseSocket">TBaseSocket</method> object. </para>
</comments>
</member>
<member name="M:Sockets.Sockets.Open">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TBaseSocket">Open</method> to create the socket connection. Descendants of <method namespace="Sockets" class="TBaseSocket">TBaseSocket</method> use <method namespace="Sockets" class="TBaseSocket">Open</method> to initiate the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, <method namespace="Sockets" class="TBaseSocket">Open</method> locates and connects to a server. For server sockets, <method namespace="Sockets" class="TBaseSocket">Open</method> opens the socket connection in a listening mode, but does not complete the connection to a client socket.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.Close">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Shuts down the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TBaseSocket">Close</method> to shut down the socket connection. <method namespace="Sockets" class="TBaseSocket">Close</method> sets the Active property to false.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, <method namespace="Sockets" class="TBaseSocket">Close</method> terminates the connection to the server. For server sockets, <method namespace="Sockets" class="TBaseSocket">Close</method> shuts down the connection so that the server socket is no longer listening for client requests.</para>
<method namespace="Sockets" class="TBaseSocket">Destroy</method>s the <method namespace="Sockets" class="TBaseSocket">TBaseSocket</method> instance and frees its memory.</para>
<method namespace="Sockets" class="TBaseSocket">Destroy</method> cleans up references in the global fix-up list for form linking. It then calls the inherited destructor.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Sockets" class="TBaseSocket">Destroy</method> directly. Call Free instead. Free checks that the object reference is not nil before calling <method namespace="Sockets" class="TBaseSocket">Destroy</method>.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.Active">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the socket connection is open and available for communication with other machines. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Before attempting to use or change the socket connection, read <property namespace="Sockets" class="TBaseSocket">Active</property> to determine whether the connection is open and ready. For client sockets, setting <property namespace="Sockets" class="TBaseSocket">Active</property> opens or shuts down a socket connection to another machine. For server sockets, setting <property namespace="Sockets" class="TBaseSocket">Active</property> opens or shuts down a listening connection that makes the socket available for client requests.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">At design time, set <property namespace="Sockets" class="TBaseSocket">Active</property> to true to make the socket open a connection when the application starts running (the default value is false). At runtime, use the Open or Close method to open or close the connection.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.BlockMode">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets or returns the blocking mode of the socket. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TBaseSocket">BlockMode</property> to set or return the blocking mode for the socket. By default, the socket is set to bmBlocking.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.BytesReceived">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the number of bytes received by the socket. </para>
<property namespace="Sockets" class="TBaseSocket">BytesSent</property> returns the number of bytes sent from the socket.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.Domain">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets or returns the protocol family used by the socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TBaseSocket">Domain</property> to set or return the protocol family used by the socket.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.Handle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the unique-4 byte identifier that represents the
<property namespace="Sockets" class="TBaseSocket">Protocol</property> sets or returns the protocol used by the socket. The socket protocol can be IP, TCP, UDP, or other network protocols.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.SockType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets or returns the socket type. </para>
<property namespace="Sockets" class="TBaseSocket">SockType</property> determines how the socket delivers its packets of information.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnCreateHandle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the handle to a socket becomes active.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TBaseSocket">OnCreateHandle</event> event handler to take specific action when the handle to a socket becomes active.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnDestroyHandle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a socket is deactivated.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TBaseSocket">OnDestroyHandle</event> event handler to take specific action when the socket is deactivated.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnError">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the socket fails in making, using, or shutting down a connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TBaseSocket">OnError</event> event handler to respond to errors that arise with the socket connection. Set the ErrorCode parameter to 0 if the <event namespace="Sockets" class="TBaseSocket">OnError</event> event handler successfully deals with the error condition, to prevent an ESocketError from being raised.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnReceive">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs after a socket receives data, but before it passes the data to the application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TBaseSocket">OnReceive</event> event handler to read from the socket connection. Use the <event namespace="Sockets" class="TBaseSocket">OnReceive</event> event to filter data before passing it back to the client application.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnSend">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs just before a client socket writes information to the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TBaseSocket">OnSend</event> event handler to perform actions just prior to sending data. Use <event namespace="Sockets" class="TBaseSocket">OnSend</event> to monitor the data stream and change it (for example, by removing linefeeds).</para>
<class namespace="Sockets">TIpSocket</class> encapsulates the network support functions, linking sockets to network protocols such as TCP/IP and UDP, as well as raw sockets and custom protocols.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Sockets">TIpSocket</class>. Use <class namespace="Sockets">TIpSocket</class> as a base class when declaring non-visual components that can appear on the component palette and be used in the form designer. Properties and methods of <class namespace="Sockets">TIpSocket</class> provide basic behavior that descendant classes inherit as well as behavior that components can override to customize their behavior.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.GetSocketAddr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Builds a valid network socket address.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">GetSocketAddr</method> to build a valid socket address based on the host name and port number. The TSocketHost and TSocketPort arguments are used to return a TSockAddr structure, which can then be passed to Connect or Bind.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.LookupHostName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Looks up the host name based on the IP address.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">LookupHostName</method> to look up the host name based on the machine's IP address.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Looks up the host address based on the host name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">LookupHostAddr</method> to look up the host address based on the machine's host name.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the port number.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">LookupPort</method> to return the port number of the IP socket. The port number is related to the service name and protocol number.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information, refer to the home page of the Internet Assigned Numbers Authority (www.iana.org), which maintains lists of port numbers and their associated protocols. Also, refer to the documentation for the application's target operating system for information on how port numbers are stored and changed in that OS.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.LookupProtocol">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the protocol number.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">LookupProtocol</method> to return the protocol number being used by the IP socket. The protocol number is based on the protocol name.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information, refer to the home page of the Internet Assigned Numbers Authority (www.iana.org), which maintains lists of protocol numbers and their associated protocols.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.LocalDomainName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the domain name for the local host.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use LocalDomain name to return the domain name for the local host.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.LocalHostName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the local host name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">LocalHostName</method> to return the host name for the local host.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the local IP address for the host machine.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">LocalHostAddr</method> to return the local IP address in string format.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.ReceiveFrom">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Receives a packet of information.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">ReceiveFrom</method> to receive a single packet of information. Note that information in the packet is not checked for length, completeness, and such, which occurs at a higher level.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.SendTo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sends a packet of information.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TIpSocket">SendTo</method> to send a single packet of information over the network. Note that information in the packet is not checked for length, completeness, and such, which occurs at a higher level.</para>
<method namespace="Sockets" class="TIpSocket">Create</method>s an instance of <method namespace="Sockets" class="TIpSocket">TIpSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TIpSocket">Create</method> to instantiate a <method namespace="Sockets" class="TIpSocket">TIpSocket</method> object. </para>
</comments>
</member>
<member name="P:Sockets.Sockets.LocalHost">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the local system.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TIpSocket">LocalHost</property> to get the name of the system that is running the application that uses the socket. <property namespace="Sockets" class="TIpSocket">LocalHost</property> is a string containing the domain name and service of the local socket endpoint, such as </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Port numbers allow a single system, identified by the <property namespace="Sockets" class="TIpSocket">LocalHost</property>Addr property, to host multiple connections simultaneously. Each combination of LocalPort and <property namespace="Sockets" class="TIpSocket">LocalHost</property>Addr can only be bound to a single socket connection.</para>
<property namespace="Sockets" class="TIpSocket">LocalHost</property> provides an alias for the local IP address given in the <property namespace="Sockets" class="TIpSocket">LocalHost</property>Addr property. Most Intranets provide host names for the IP addresses of systems on the net. For more information on defining a host name for a given system, contact your network administrator.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.LocalPort">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the ID number of the port used by the socket connection. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TIpSocket">LocalPort</property> to determine the port number that is bound to the socket connection. For server endpoints of listening connections, <property namespace="Sockets" class="TIpSocket">LocalPort</property> is the ID associated with the service the server socket provides. For client or server endpoints of connections to another socket, <property namespace="Sockets" class="TIpSocket">LocalPort</property> is usually an arbitrary value picked when the connection was made.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Many values of <property namespace="Sockets" class="TIpSocket">LocalPort</property> are associated by convention with a particular service such as FTP or HTTP. </para>
</comments>
</member>
<member name="P:Sockets.Sockets.RemoteHost">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the remote system. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TIpSocket">RemoteHost</property> to get the name of the system on the other end of the socket connection. <property namespace="Sockets" class="TIpSocket">RemoteHost</property> is a string containing the domain name and service of the remote endpoint of the socket connection, such as </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the ID number of the port used by the RemoteHost to form the socket connection. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TIpSocket">RemotePort</property> to determine the port number used by the socket on the other end of the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Port numbers allow a single system, identified by the RemoteHost property, to host multiple connections simultaneously. Each combination of <property namespace="Sockets" class="TIpSocket">RemotePort</property> and RemoteHost can only be bound to a single socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Many port numbers are associated by convention with a particular service such as ftp or http. To determine whether the value of <property namespace="Sockets" class="TIpSocket">RemotePort</property> is associated with a specific service, use the LookupProtocol method.</para>
<para>If a client socket requests a specific port to indicate a desired service, the value of <property namespace="Sockets" class="TIpSocket">RemotePort</property> for the actual connection may differ from the requested port number. Most server sockets listen on the port associated with a service, but switch to an arbitrary available port number for forming connections.</para>
<class namespace="Sockets">TCustomIpClient</class> encapsulates the client network functions, linking sockets to network protocols such as TCP/IP and UDP, as well as raw sockets and custom protocols.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Sockets">TCustomIpClient</class>. Use <class namespace="Sockets">TCustomIpClient</class> as a base class when declaring non-visual components that can appear on the component palette and be used in the form designer. Properties and methods of <class namespace="Sockets">TCustomIpClient</class> provide basic behavior that descendant classes inherit as well as behavior that components can override to customize their behavior.</para>
<method namespace="Sockets" class="TCustomIpClient">Connect</method>s the local socket to the remote socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <method namespace="Sockets" class="TCustomIpClient">Connect</method> to true to connect the local socket to the remote socket.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.GetThreadObject">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a reference to the TThread object for the currently executing
<method namespace="Sockets" class="TCustomIpClient">Create</method>s an instance of <method namespace="Sockets" class="TCustomIpClient">TCustomIpClient</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TCustomIpClient">Create</method> to instantiate a <method namespace="Sockets" class="TCustomIpClient">TCustomIpClient</method> object. </para>
</comments>
</member>
<member name="M:Sockets.Sockets.Open">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TCustomIpClient">Open</method> to create and initiate the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, <method namespace="Sockets" class="TCustomIpClient">Open</method> locates and connects to a server. For server sockets, <method namespace="Sockets" class="TCustomIpClient">Open</method> opens the socket connection in a listening mode, but does not complete the connection to a client socket.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.Close">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Shuts down the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TCustomIpClient">Close</method> to shut down the socket connection. This method performs the same functions as Disconnect.</para>
<method namespace="Sockets" class="TCustomIpClient">Disconnect</method>s the local socket from the remote socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TCustomIpClient">Disconnect</method> to break the connection between the local and remote sockets. This method performs the same function as Close.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.Connected">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the socket connection is open and available for communication with other machines.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Sockets" class="TCustomIpClient">Connected</property> before trying to use or change the socket connection. <property namespace="Sockets" class="TCustomIpClient">Connected</property> indicates whether the socket connection has been established. When <property namespace="Sockets" class="TCustomIpClient">Connected</property> is true, the socket is open and available for use. When <property namespace="Sockets" class="TCustomIpClient">Connected</property> is false, the socket is closed and can be changed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To open a socket, use the Open method. To close a socket, use the Close method.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnConnect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs on client sockets just after the connection to the server is opened.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TCustomIpClient">OnConnect</event> event handler for a client socket to take specific action after the connection to a server socket has been established. Depending on the service, this may be the point when the socket should start reading or writing over the connection.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnDisconnect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs on client sockets just after the connection to the server is closed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TCustomIpClient">OnDisconnect</event> event handler for a client socket to take specific action just after the connection to a server socket is terminated. </para>
<method namespace="Sockets" class="TRawSocket">Create</method>s an instance of a <method namespace="Sockets" class="TRawSocket">TRawSocket</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TRawSocket">Create</method> to instantiate a <method namespace="Sockets" class="TRawSocket">TRawSocket</method> object. </para>
<class namespace="Sockets">TUdpSocket</class> is the UDP component<condition language="CBuilder">.</condition>
</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Sockets">TUdpSocket</class> to create UDP-based applications. Add a <class namespace="Sockets">TUdpSocket</class> object to a form or data module to turn an application into a UDP/IP client and server. <class namespace="Sockets">TUdpSocket</class> specifies a desired connection to a UDP/IP server, manages the connection when it is open, and terminates the connection when the application is through. It also listens for requests for UDP/IP connections from other machines and establishes connections when requests are received.</para>
<method namespace="Sockets" class="TUdpSocket">Create</method>s an instance of <method namespace="Sockets" class="TUdpSocket">TUdpSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TUdpSocket">Create</method> to instantiate a <method namespace="Sockets" class="TUdpSocket">TUdpSocket</method> object. </para>
<class namespace="Sockets">TClientSocketThread</class> enables creation of separate threads of execution for the client socket in an application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Create a <class namespace="Sockets">TClientSocketThread</class> (or a descendant of the class) to represent an execution thread for the client socket in a multi-threaded application. Each new instance of <class namespace="Sockets">TClientSocketThread</class>, a TThread descendant, is a new thread of execution. Using a separate <class namespace="Sockets">TClientSocketThread</class> allows the client socket to block without blocking the whole application.</para>
<method namespace="Sockets" class="TClientSocketThread">Create</method>s an instance of a <method namespace="Sockets" class="TClientSocketThread">TClientSocketThread</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TClientSocketThread">Create</method> to create an instance of a <method namespace="Sockets" class="TClientSocketThread">TClientSocketThread</method> object.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.SyncProc">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Method where data synchronization is actually performed. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In subclasses of <method namespace="Sockets" class="TClientSocketThread">TClientSocketThread</method>, override <method namespace="Sockets" class="TClientSocketThread">SyncProc</method> to perform synchronization between threads. Put code in it to be executed by the main thread. Do not call this protected method directly; instead, call Execute<method namespace="Sockets" class="TClientSocketThread">SyncProc</method>.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.Execute">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the code which executes when the thread is run. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TClientSocketThread">Execute</method> to execute the code that should be executed when the thread runs. <method namespace="Sockets" class="TClientSocketThread">Execute</method> is responsible for checking the value of the Terminated property to determine if the thread needs to exit.</para>
<para>Do not use the properties and methods of other objects directly in the <method namespace="Sockets" class="TClientSocketThread">Execute</method> method of a thread. Instead, separate the use of other objects into a separate procedure call, and call that procedure by passing it as a parameter to the Synchronize method.</para>
</note>
</comments>
</member>
<member name="M:Sockets.Sockets.ExecuteSyncProc">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Synchronizes data between threads. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Objects in the client socket thread should not directly manipulate
data in the application's main thread. Attempting to do so will cause
synchronization problems and, most likely, the application will crash. To avoid
synchronization errors, override the SyncProc method to include instructions
<method namespace="Sockets" class="TClientSocketThread">Destroy</method>s the <method namespace="Sockets" class="TClientSocketThread">TClientSocketThread</method> object and releases the memory allocated to it.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Sockets" class="TClientSocketThread">Destroy</method> in an application. Instead, use Free to destroy a thread when FreeOnTerminate is False.</para>
<method namespace="Sockets" class="TClientSocketThread">Destroy</method> signals the thread to terminate and then waits for the thread to return before calling the inherited <method namespace="Sockets" class="TClientSocketThread">Destroy</method> method.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.ClientSocket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Refers to the client socket handling the connection in that thread.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TClientSocketThread">ClientSocket</property> to obtain access to the client socket object handling the connection in the current thread of execution.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the server socket's thread.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TClientSocketThread">ServerSocketThread</property> get access to the thread object of the server socket.</para>
<class namespace="Sockets">TServerSocketThread</class> enables creation of separate threads of execution for the server socket in an application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Create <class namespace="Sockets">TServerSocketThread</class> (or a descendant of the class) to represent an execution thread for the server socket in a multi-threaded application. Each new instance of a <class namespace="Sockets">TServerSocketThread</class>, a TThread descendant, is a new thread of execution. Using a separate <class namespace="Sockets">TServerSocketThread</class> allows the server socket to block without blocking the whole application.</para>
<method namespace="Sockets" class="TServerSocketThread">Create</method>s an instance of a <method namespace="Sockets" class="TServerSocketThread">TServerSocketThread</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TServerSocketThread">Create</method> to create an instance of a <method namespace="Sockets" class="TServerSocketThread">TServerSocketThread</method> object.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.ClearThreadPool">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Terminates all of the threads in the thread pool.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The thread pool is a list of client socket threads which are available to handle connection requests. This list is kept to allow reuse of old threads and improve performance. It is sometimes useful to destroy all of the thread object instances in this list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TServerSocketThread">ClearThreadPool</method> to terminate all of the threads in the thread pool list. Any suspended thread in the pool will be resumed so that termination can proceed.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.Execute">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the code which executes when the thread is run. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Sockets" class="TServerSocketThread">Execute</method> to execute the code that should be executed when the thread runs. <method namespace="Sockets" class="TServerSocketThread">Execute</method> is responsible for checking the value of the Terminated property to determine if the thread needs to exit.</para>
<para>Do not use the properties and methods of other objects directly in the <method namespace="Sockets" class="TServerSocketThread">Execute</method> method of a thread. Instead, separate the use of other objects into a separate procedure call, and call that procedure by passing it as a parameter to the Synchronize method.</para>
<method namespace="Sockets" class="TServerSocketThread">Destroy</method>s the <method namespace="Sockets" class="TServerSocketThread">TServerSocketThread</method> object and releases the memory allocated to it.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Sockets" class="TServerSocketThread">Destroy</method> in an application. Instead, use Free to destroy a thread when FreeOnTerminate is False.</para>
<method namespace="Sockets" class="TServerSocketThread">Destroy</method> signals the thread to terminate and then waits for the thread to return before calling the inherited <method namespace="Sockets" class="TServerSocketThread">Destroy</method> method.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.ServerSocket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the TCustomTcpServer object that manages all the
TClientSocketThread objects for its client connections. </para>
<property namespace="Sockets" class="TServerSocketThread">ServerSocket</property> to get direct access to the
listening socket object that spawned the thread for a client connection it
accepted. TServerSocketThread passes events and errors to the appropriate event
handlers assigned to
<property namespace="Sockets" class="TServerSocketThread">ServerSocket</property>. T
<property namespace="Sockets" class="TServerSocketThread">ServerSocket</property>Thread adds itself to the
cache of threads maintained by
<property namespace="Sockets" class="TServerSocketThread">ServerSocket</property> from its constructor, and
removes itself when the thread terminates.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.ThreadCacheSize">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of <property namespace="Sockets" class="TServerSocketThread">TServerSocketThread</property> objects cached for reuse by new connections to client sockets. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Sockets" class="TServerSocketThread">ThreadCacheSize</property> to specify the number of threads that are cached for reuse. The ideal value for <property namespace="Sockets" class="TServerSocketThread">ThreadCacheSize</property> depends on the number and frequency of client socket requests received by the server socket. If <property namespace="Sockets" class="TServerSocketThread">ThreadCacheSize</property> is too low, the server socket will spend more time freeing and creating threads when client connections are accepted. If <property namespace="Sockets" class="TServerSocketThread">ThreadCacheSize</property> is too high, the server socket may unnecessarily lock up the memory for threads that are never reused.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.ThreadPool">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A list of all the client socket threads created by the <property namespace="Sockets" class="TServerSocketThread">TServerSocketThread</property> object. </para>
<property namespace="Sockets" class="TServerSocketThread">TServerSocketThread</property> objects listen for requests on the network and delegate them to client socket threads. Each client socket thread is added to the list <property namespace="Sockets" class="TServerSocketThread">ThreadPool</property> after it is created. Creating and destroying client socket threads can be quite time consuming, so whenever one completes its work on a given connection it becomes dormant. When a new connection request is received, the <property namespace="Sockets" class="TServerSocketThread">ThreadPool</property> is checked for dormant client socket threads. If one is available, it is assigned the connection. If not, a new client socket thread created. By reusing previously-created threads, the application's performance is improved.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnGetThread">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates and initializes a client socket thread when a connection is requested.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An <event namespace="Sockets" class="TServerSocketThread">OnGetThread</event> event occurs when a connection is requested. The event handler creates an instance of TClientSocketThread and initializes it. Write an event handler on TCustomTcpServer to create and initialize instances of your own client socket thread class.</para>
<class namespace="Sockets">TCustomTcpServer</class> is the ancestor object of all the server socket descendants<condition language="CBuilder">.</condition>
</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Sockets">TCustomTcpServer</class>. Use <class namespace="Sockets">TCustomTcpServer</class> as a base class when declaring non-visual components that can appear on the component palette and be used in the form designer. Properties and methods of <class namespace="Sockets">TCustomTcpServer</class> provide basic behavior that descendant classes inherit as well as behavior that components can override to customize their behavior.</para>
<method namespace="Sockets" class="TCustomTcpServer">Accept</method> is called automatically in response to notifications that a client socket is requesting a connection. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Sockets" class="TCustomTcpServer">Accept</method> method for <method namespace="Sockets" class="TCustomTcpServer">TCustomTcpServer</method> does nothing with the notification. Descendants of <method namespace="Sockets" class="TCustomTcpServer">TCustomTcpServer</method> that represent listening server sockets override this method to accept the connection to the client socket. In the second declaration of the method, a TCustomIpClient object is created (as ClientSocket) to handle the connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Listens for TCP connections.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TCustomTcpServer">WaitForConnection</method> to listen for TCP connections on the port specified by the LocalPort property. The thread will block until a connection request is received.</para>
<method namespace="Sockets" class="TCustomTcpServer">Create</method>s an instance of <method namespace="Sockets" class="TCustomTcpServer">TCustomTcpServer</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TCustomTcpServer">Create</method> to instantiate a <method namespace="Sockets" class="TCustomTcpServer">TCustomTcpServer</method> object.</para>
<method namespace="Sockets" class="TCustomTcpServer">Open</method>s the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TCustomTcpServer">Open</method> to initiate the socket connection. <method namespace="Sockets" class="TCustomTcpServer">Open</method> sets the Active property to true.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, <method namespace="Sockets" class="TCustomTcpServer">Open</method> locates and connects to a server. For server sockets, <method namespace="Sockets" class="TCustomTcpServer">Open</method> opens the socket connection in a listening mode, but does not complete the connection to a client socket.</para>
</comments>
</member>
<member name="M:Sockets.Sockets.Close">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Shuts down the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Sockets" class="TCustomTcpServer">Close</method> to shut down the socket connection. <method namespace="Sockets" class="TCustomTcpServer">Close</method> sets the Active property to false.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, <method namespace="Sockets" class="TCustomTcpServer">Close</method> terminates the connection to the server. For server sockets, <method namespace="Sockets" class="TCustomTcpServer">Close</method> shuts down the connection so that the server socket is no longer listening for client requests.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.BlockMode">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets or returns the blocking mode of the socket. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Sockets" class="TCustomTcpServer">BlockMode</property> to set or return the blocking mode for the socket. By default, the socket is set to bmThreadBlocking.</para>
</comments>
</member>
<member name="P:Sockets.Sockets.Listening">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the server application to listen for client requests. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the T<property namespace="Sockets" class="TCustomTcpServer">ServerSocketThread</property> in use.</para>
<property namespace="Sockets" class="TCustomTcpServer">ServerSocketThread</property> is a reference to the server socket thread object.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnAccept">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs on server sockets just after the connection to a client socket is accepted.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TCustomTcpServer">OnAccept</event> event handler for a server socket to take specific action after the connection to a client socket has been accepted. This is the first point when information is available about the local port and IP address that will be used in the server endpoint of the connection. The port number, and possibly the IP address, will differ from those of the listening socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Server sockets open a socket connection for listening to establish a queue to hold client requests. After a request from the queue is accepted by the server socket, an <event namespace="Sockets" class="TCustomTcpServer">OnAccept</event> event occurs. After the server socket accepts the connection, the client socket completes the connection, and an OnConnect event occurs for the client socket.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnGetThread">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A wrapper for the TServerSocketThread event of the same name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TCustomTcpServer">OnGetThread</event> event handler to create and initialize your own thread object for the server connection to use. This event is exactly the same as the <event namespace="Sockets" class="TCustomTcpServer">OnGetThread</event> event of the TServerSocketThread object referenced in ServerSocketThread.</para>
</comments>
</member>
<member name="E:Sockets.Sockets.OnListening">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a server socket begins listening for connections.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Sockets" class="TCustomTcpServer">OnListening</event> event to take specific action when a server begins listening for a connection.</para>
<class namespace="Sockets">TTcpServer</class> is the TCP server component<condition language="CBuilder">.</condition>
</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Sockets">TTcpServer</class> to create TCP server applications.</para>
<class namespace="AutoDisp">TWebDispatch</class> implements the WebDispatch property of an auto-dispatching component such as <condition os="Windows">TXMLBroker, </condition>THTTPSoapDispatcher<condition os="Windows">,</condition> or TWSDLHTMLPublish. It specifies the path info portion of the URL for messages directed at the component, the type of messages to which the component can respond, and allows an application to disable the auto-dispatching so that it does not respond directly to HTTP messages from a Web browser.</para>
<method namespace="AutoDisp" class="TWebDispatch">Create</method>s and initializes an instance of <method namespace="AutoDisp" class="TWebDispatch">TWebDispatch</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="AutoDisp" class="TWebDispatch">TWebDispatch</method> constructor is called from the constructor of the auto-dispatching component that uses it to implement its WebDispatch property. The AComponent parameter specifies the auto-dispatching component that uses the <method namespace="AutoDisp" class="TWebDispatch">TWebDispatch</method> instance.</para>
<method namespace="AutoDisp" class="TWebDispatch">Destroy</method>s an instance of <method namespace="AutoDisp" class="TWebDispatch">TWebDispatch</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="AutoDisp" class="TWebDispatch">Destroy</method>. The <method namespace="AutoDisp" class="TWebDispatch">TWebDispatch</method> instance is freed by the auto-dispatching component that uses it.</para>
</comments>
</member>
<member name="P:AutoDisp.AutoDisp.Mask">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides a mask object for comparing the PathInfo property with another path.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="AutoDisp" class="TWebDispatch">Mask</property> to compare the PathInfo property with the path portion of a URL. <property namespace="AutoDisp" class="TWebDispatch">Mask</property> is a T<property namespace="AutoDisp" class="TWebDispatch">Mask</property> object that represents the string specified by PathInfo.</para>
</comments>
</member>
<member name="P:AutoDisp.AutoDisp.Enabled">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the Web dispatcher passes requests to the object using the <property namespace="AutoDisp" class="TWebDispatch">TWebDispatch</property> object. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="AutoDisp" class="TWebDispatch">Enabled</property> to indicate whether the object using the Web dispatcher responds directly to HTTP request messages. By default, <property namespace="AutoDisp" class="TWebDispatch">Enabled</property> is true, but an application may disable the auto-dispatching of a component because</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The application responds to request messages using an action item on the Web dispatcher rather than using the auto-dispatch feature of the component that uses <property namespace="AutoDisp" class="TWebDispatch">TWebDispatch</property> as its WebDispatch property. Action items give you greater control over the order in which the dispatcher passes a request message on for handling, and let you embed the default action of the auto-dispatching component with other actions performed by the action item.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The application uses other features of the auto-dispatching component but does not want it to respond to HTTP request messages. For example, a Web client may include an XML broker to provide data packets that appear in the generated HTML pages, but not allow Web browsers to apply updates. When <property namespace="AutoDisp" class="TWebDispatch">Enabled</property> is false, the Web dispatcher does not pass update messages on to the XML broker.</para>
</comments>
</member>
<member name="P:AutoDisp.AutoDisp.PathInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the path portion of the Uniform Resource Identifier (URI) for which the auto-dispatching component handles requests.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="AutoDisp" class="TWebDispatch">PathInfo</property> to the path portion of the URI for the target of any request messages serviced by the auto-dispatching component that uses <property namespace="AutoDisp" class="TWebDispatch">TWebDispatch</property>. The Web dispatcher matches components to request messages by comparing <property namespace="AutoDisp" class="TWebDispatch">PathInfo</property> with the path portion of the URI specified as the target of the request. If the <property namespace="AutoDisp" class="TWebDispatch">PathInfo</property> properties match, and the MethodType matches, the Web dispatcher invokes the auto-dispatching object so that it can respond to the message.</para>
<class namespace="AutoDisp">TWebPathInfo</class> describes the HTTP messages to which an auto-dispatching component responds.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TWebPageInfo implements the PathInfo property of an auto-dispatching component such as TWebDispatch. It specifies the path info portion of the URL for messages directed at the component.</para>
</comments>
</member>
<member name="P:AutoDisp.AutoDisp.Mask">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides a mask object for comparing the PathInfo property with another path.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Mask to compare the PathInfo property with the path portion of a URL. Mask is a TMask object that represents the string specified by PathInfo.</para>
</comments>
</member>
<member name="P:AutoDisp.AutoDisp.PathInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the path portion of the Uniform Resource Identifier (URI) for which the auto-dispatching component handles requests.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set PathInfo to the path portion of the URI for the target of any request messages serviced by the auto-dispatching component that uses <property namespace="AutoDisp" class="TWebPathInfo">TWebPathInfo</property>. The Web dispatcher matches components to request messages by comparing PathInfo with the path portion of the URI specified as the target of the request. If the PathInfo properties match, and the MethodType matches, the Web dispatcher invokes the auto-dispatching object so that it can respond to the message.</para>
<class namespace="HTTPProd">THTMLTagAttributes</class> is the base class for all objects that represent the attributes of an HTML tag.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of TCustomContentProducer use <class namespace="HTTPProd">THTMLTagAttributes</class> objects to encapsulate the options added to the HTML tags in the HTML commands that they produce. When the TCustomContentProducer object generates HTML commands, it looks up the tag attributes represented by the properties of its tag attributes objects, and generates the appropriate tag options.</para>
<method namespace="HTTPProd" class="THTMLTagAttributes">Create</method>s an instance of <method namespace="HTTPProd" class="THTMLTagAttributes">THTMLTagAttributes</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="THTMLTagAttributes">Create</method> to create and initialize an instance of <method namespace="HTTPProd" class="THTMLTagAttributes">THTMLTagAttributes</method> at runtime. After calling the inherited constructor, <method namespace="HTTPProd" class="THTMLTagAttributes">Create</method> sets the Producer property to the value of the Producer parameter.</para>
</comments>
</member>
<member name="M:HTTPProd.HTTPProd.Changed">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an OnChange event.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="THTMLTagAttributes">Changed</method> from a descendant of <method namespace="HTTPProd" class="THTMLTagAttributes">THTMLTagAttributes</method> after a tag option introduced by that descendant changes. <method namespace="HTTPProd" class="THTMLTagAttributes">Changed</method> is exposed as a protected method so that component writers can create descendants of <method namespace="HTTPProd" class="THTMLTagAttributes">THTMLTagAttributes</method> which correctly trigger the OnChange event handler.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Changes all properties of the tag attributes object back to their initial settings.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="THTMLTagAttributes">RestoreDefaults</method> to undo any changes that were made to the tag attributes either programmatically, or at design time. RestoreAttributes sets the Custom property to an empty string.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.Producer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the content producer that uses the <property namespace="HTTPProd" class="THTMLTagAttributes">THTMLTagAttributes</property> object to represent the options for one of the HTML tags in the content it produces.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPProd" class="THTMLTagAttributes">Producer</property> to gain access to the HTML producer object that is using the <property namespace="HTTPProd" class="THTMLTagAttributes">THTMLTagAttributes</property> object. The <property namespace="HTTPProd" class="THTMLTagAttributes">THTMLTagAttributes</property> object can use the <property namespace="HTTPProd" class="THTMLTagAttributes">Producer</property> property in an OnChange event handler to notify the TCustomContent<property namespace="HTTPProd" class="THTMLTagAttributes">Producer</property> object of changes to the attributes it represents.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.Custom">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents a tag option and its value in an HTML tag.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPProd" class="THTMLTagAttributes">Custom</property> to represent one or more options to be added to an HTML tag. Each option and its value should have the form </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The options specified by <property namespace="HTTPProd" class="THTMLTagAttributes">Custom</property> should be separated by spaces. For example, to merge a cell in an HTML table with the three adjacent cells to the left and below, the table data tag for the cell requires the ROWSPAN and COLSPAN options to be set. The value of <property namespace="HTTPProd" class="THTMLTagAttributes">Custom</property> to specify these values would be the string</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HTML producer inserts the <property namespace="HTTPProd" class="THTMLTagAttributes">Custom</property> string into the HTML tag when it generates its Content.</para>
</comments>
</member>
<member name="E:HTTPProd.HTTPProd.OnChange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately after a tag attributes property changes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="HTTPProd" class="THTMLTagAttributes">OnChange</event> event handler to take specific action whenever any of the properties of the tag attributes object changes. When <event namespace="HTTPProd" class="THTMLTagAttributes">OnChange</event> occurs, the tag attributes object already has the new property setting. Use an <event namespace="HTTPProd" class="THTMLTagAttributes">OnChange</event> event handler to inform the HTML content producer whenever the attributes of a tag change so that the content producer can update the content it is producing.</para>
<class namespace="HTTPProd">THTMLTableAttributes</class> represents the display attributes of an HTML table tag.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPProd">THTMLTableAttributes</class> to describe the desired appearance of an HTML table. The properties of the <class namespace="HTTPProd">THTMLTableAttributes</class> object correspond to the options that can be added to the HTML table tag. When the attributes of all the parts of the HTML table have been specified, an HTML producer object creates the HTML commands to specify the table as described.</para>
<method namespace="HTTPProd" class="THTMLTableAttributes">Create</method>s an instance of <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="THTMLTableAttributes">Create</method> to create and initialize a <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method> object. The Producer parameter specifies the HTML producer that is using the <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method> object to specify the attributes of an HTML table that makes up part of its output.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited constructor, <method namespace="HTTPProd" class="THTMLTableAttributes">Create</method> initializes</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Width to a value of 100.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Border to a value of -1.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">CellPadding to a value of -1.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">CellSpacing to a value of -1.</para>
</comments>
</member>
<member name="M:HTTPProd.HTTPProd.AssignTo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the properties of a <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method> object to another <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications cannot call the protected <method namespace="HTTPProd" class="THTMLTableAttributes">AssignTo</method> method. To assign the properties of a <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method> object to another object, use the Assign method of the destination object. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the Assign method of another object specifies a <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method> object as the source of the assignment, the <method namespace="HTTPProd" class="THTMLTableAttributes">AssignTo</method> method of the <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method> object is called. <method namespace="HTTPProd" class="THTMLTableAttributes">AssignTo</method> checks whether the Dest parameter is another <method namespace="HTTPProd" class="THTMLTableAttributes">THTMLTableAttributes</method> object, and if so, copies the values of the Align, Border, CellSpacing, CellPadding, and Width properties. If Dest is any other class of object, the inherited method is called.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Changes all properties of the table attributes object back to their initial settings.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="THTMLTableAttributes">RestoreDefaults</method> to undo any changes that were made to the table attributes either programmatically, or using the response editor at design time. RestoreAttributes sets</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Align to haDefault. (Delphi) or haDefault; (C++)</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Border, CellPadding, and CellSpacing to ΓÇô1. (Delphi) or -1; (C++)</para>
<condition language="CBuilder"/>Custom to an empty string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Width to 100. (Delphi) or 100; (C++)</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.Align">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the alignment of the table within the HTML document.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="THTMLTableAttributes">Align</property> to indicate the desired alignment of the table within the HTML document, or within the cell of a surrounding HTML table object. <property namespace="HTTPProd" class="THTMLTableAttributes">Align</property> indicates the desired value of the <property namespace="HTTPProd" class="THTMLTableAttributes">Align</property> option of the HTML table tag.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The default value of <property namespace="HTTPProd" class="THTMLTableAttributes">Align</property> is haDefault, which means the web browser that reads the HTML document positions the HTML table where it wants. </para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.BgColor">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the background color of the HTML table.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPProd" class="THTMLTableAttributes">BgColor</property> to indicate the desired background color of the HTML table. The value of <property namespace="HTTPProd" class="THTMLTableAttributes">BgColor</property> is the name of color. This can be one of the following strings:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the <property namespace="HTTPProd" class="THTMLTableAttributes">BgColor</property> property of the HTML attributes objects for the pieces of the table for more involved color effects.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.Border">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the thickness of the border drawn around the HTML table.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="THTMLTableAttributes">Border</property> to specify whether a border should be drawn around the table, and if so, how thick it should be. The thickness specified by any particular value of border depends on the web browser that views the HTML table. For any browser, however, larger numbers indicate thicker borders. A value of -1 indicates that no border should be drawn around the table.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.CellSpacing">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the amount of space to leave between cells in the HTML table.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="THTMLTableAttributes">CellSpacing</property> to specify how many pixels of whitespace should appear between the cells in the table. A value of -1 indicates that the web browser should decide how to separate the cells of the HTML table.</para>
<property namespace="HTTPProd" class="THTMLTableAttributes">CellSpacing</property> refers to the whitespace between cells in an HTML table, not the thickness of the lines drawn to separate rows and columns.</para>
</note>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.CellPadding">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the amount of space to leave around the contents of each cell in the HTML table.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="THTMLTableAttributes">CellPadding</property> to specify how many pixels of whitespace should appear between a cell's contents and the edges of the cell. A value of -1 indicates that the web browser should decide how to pad the cells of the HTML table.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.Width">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the width of the entire HTML table.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="THTMLTableAttributes">Width</property> to indicate the desired width of the HTML table as a percentage of the width of the web browser window. If the value of <property namespace="HTTPProd" class="THTMLTableAttributes">Width</property> is too small for the contents of the table, the web browser will ignore this property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The default value of <property namespace="HTTPProd" class="THTMLTableAttributes">Width</property> is 100, meaning the table will span the entire browser window. In this case, the value of the Align property is meaningless.</para>
<class namespace="HTTPProd">THTMLTableElementAttributes</class> is the common base class for objects that describe the display attributes of parts of an HTML table.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the properties of <class namespace="HTTPProd">THTMLTableElementAttributes</class> to describe the desired appearance of a piece of an HTML table. The properties of <class namespace="HTTPProd">THTMLTableElementAttributes</class> correspond to the common options that can be added to the tags for the parts of the HTML table. When the attributes of all the parts of the HTML table have been specified, an HTML producer object creates the HTML commands to specify the table as described.</para>
</comments>
</member>
<member name="M:HTTPProd.HTTPProd.AssignTo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the properties of a <method namespace="HTTPProd" class="THTMLTableElementAttributes">THTMLTableElementAttributes</method> object to another <method namespace="HTTPProd" class="THTMLTableElementAttributes">THTMLTableElementAttributes</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications can not call the protected <method namespace="HTTPProd" class="THTMLTableElementAttributes">AssignTo</method> method. To assign the properties of a <method namespace="HTTPProd" class="THTMLTableElementAttributes">THTMLTableElementAttributes</method> object to another object, use the Assign method of the destination object. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the Assign method of another object specifies a <method namespace="HTTPProd" class="THTMLTableElementAttributes">THTMLTableElementAttributes</method> object as the source of the assignment, the <method namespace="HTTPProd" class="THTMLTableElementAttributes">AssignTo</method> method of the <method namespace="HTTPProd" class="THTMLTableElementAttributes">THTMLTableElementAttributes</method> object is called. <method namespace="HTTPProd" class="THTMLTableElementAttributes">AssignTo</method> checks whether the Dest parameter is another <method namespace="HTTPProd" class="THTMLTableElementAttributes">THTMLTableElementAttributes</method> object, and if so, copies the values of the BgColor, Align, and VAlign properties. If Dest is any other class of object, the inherited method is called.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Changes all properties of the attributes object back to their initial settings.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="THTMLTableElementAttributes">RestoreDefaults</method> to undo any changes that were made to the table element attributes either programmatically, or using the Object Inspector at design time. RestoreAttributes sets</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Align to haDefault, and VAlign to haVDefault.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">BgColor to an empty string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Custom to an empty string.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.Align">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the horizontal alignment of the contents of the HTML table element.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="THTMLTableElementAttributes">Align</property> to indicate the desired horizontal alignment of the contents of the cell or cells indicated by the table element. <property namespace="HTTPProd" class="THTMLTableElementAttributes">Align</property> indicates the desired value of the <property namespace="HTTPProd" class="THTMLTableElementAttributes">Align</property> option of the HTML tag for the table element.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The default value of <property namespace="HTTPProd" class="THTMLTableElementAttributes">Align</property> is haDefault, which means the web browser that reads the HTML document horizontally positions the contents of the table element wherever it wishes.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="HTTPProd" class="THTMLTableElementAttributes">Align</property> property of table data cells or header cells overrides the <property namespace="HTTPProd" class="THTMLTableElementAttributes">Align</property> property of the table row in which they appear.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.BgColor">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the background color of the HTML table element.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPProd" class="THTMLTableElementAttributes">BgColor</property> to indicate the desired background color of the HTML table element. The value of <property namespace="HTTPProd" class="THTMLTableElementAttributes">BgColor</property> is the name of color. This can be one of the following strings:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the <property namespace="HTTPProd" class="THTMLTableElementAttributes">BgColor</property> property of the THTMLTableAttributes object to set a background color for the entire table. Use the <property namespace="HTTPProd" class="THTMLTableElementAttributes">BgColor</property> property of the table element attributes object to make a table element stand out from the rest of the table.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.VAlign">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the vertical alignment of the contents of the HTML table element.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="THTMLTableElementAttributes">VAlign</property> to indicate the desired vertical alignment of the contents of the HTML table element. <property namespace="HTTPProd" class="THTMLTableElementAttributes">VAlign</property> indicates the desired value of the <property namespace="HTTPProd" class="THTMLTableElementAttributes">VAlign</property> option of the HTML tag for the table element.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The default value of <property namespace="HTTPProd" class="THTMLTableElementAttributes">VAlign</property> is haVDefault, which means the web browser that reads the HTML document positions the contents of cells in the table element wherever it wishes vertically.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="HTTPProd" class="THTMLTableElementAttributes">VAlign</property> property of table data cells or header cells overrides the <property namespace="HTTPProd" class="THTMLTableElementAttributes">VAlign</property> property of the table row in which they appear.</para>
<class namespace="HTTPProd">THTMLTableHeaderAttributes</class> represents the display attributes of the header tag in an HTML table.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPProd">THTMLTableHeaderAttributes</class> to describe the desired appearance of a header cell in an HTML table. The properties of the <class namespace="HTTPProd">THTMLTableHeaderAttributes</class> object correspond to the options that can be added to the HTML header tag (TH). When the attributes of all the parts of the HTML table have been specified, the HTML content producer creates the HTML commands to specify the table as described.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.Caption">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the text that appears in the header cell.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set the <property namespace="HTTPProd" class="THTMLTableHeaderAttributes">Caption</property> property to provide a caption for the column that contains the header cell. If the header cell is used by a dataset table producer or a query table producer, the <property namespace="HTTPProd" class="THTMLTableHeaderAttributes">Caption</property> property overrides the field name that would label the column by default.</para>
<class namespace="HTTPProd">THTMLTableRowAttributes</class> represents the display attributes of the row tag in an HTML table.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPProd">THTMLTableRowAttributes</class> to describe the desired appearance of a row of an HTML table. The properties of the <class namespace="HTTPProd">THTMLTableRowAttributes</class> object correspond to the options that can be added to the HTML row tag (TR). When the attributes of all the parts of the HTML table have been specified, the content producer creates the HTML commands to specify the table as described.</para>
<class namespace="HTTPProd">THTMLTableCellAttributes</class> represents the display attributes of an HTML table cell tag.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPProd">THTMLTableCellAttributes</class> to describe the desired appearance of a cell in an HTML table. The properties of the <class namespace="HTTPProd">THTMLTableCellAttributes</class> object correspond to the options that can be added to the HTML table data tag (TD). When the attributes of all the parts of the HTML table have been specified, an HTML producer object creates the HTML commands to specify the table as described.</para>
<class namespace="HTTPProd">TBasePageProducer</class> is a base class for objects that produce a string of HTML commands based on an input template.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="HTTPProd">TBasePageProducer</class>. Instead, use <class namespace="HTTPProd">TBasePageProducer</class> as a base class when defining a page producer. <class namespace="HTTPProd">TBasePageProducer</class> has two descendants, </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TCustomPageProducer, which is the base class for page producers that produce content based primarily on the content of HTTP messages and an OnHTML event handler. Examples include TPageProducer and TDataSetPageProducer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TComponentsPageProducer, which is the base class for page producers that assemble content from components that generate HTML. Examples include TAdapterPageProducer. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A page producer is an object that converts an HTML template into a string of HTML commands which can be interpreted by a client application such as a Web browser. HTML templates include HTML commands and HTML-transparent tags that are replaced with customized content by the page producer.</para>
</comments>
</member>
<member name="M:HTTPProd.HTTPProd.Content">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the content produced by the content producer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="TBasePageProducer">Content</method> to retrieve the content for using in an HTTP response message. <method namespace="HTTPProd" class="TBasePageProducer">TBasePageProducer</method> attempts to locate a default template and uses that to generate the resulting content.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the content produced in response to input read from a stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="TBasePageProducer">ContentFromStream</method> to retrieve the content produced by the content producer based on the information provided by the Stream parameter.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the ScriptEngine property is assigned, the page producer generates its content using a special script-producer component. When ScriptEngine is not assigned, the page producer uses only the OnHTMLTag event, plus any other built-in translations provided by a descendant class. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the content produced in response to an input string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="TBasePageProducer">ContentFromString</method> to retrieve the content produced by the content producer based on the information provided by the S parameter. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the ScriptEngine property is assigned, the page producer generates its content using a special script-producer component. When ScriptEngine is not assigned, the page producer uses only the OnHTMLTag event, plus any other built-in translations provided by a descendant class. </para>
<method namespace="HTTPProd" class="TBasePageProducer">Create</method>s an instance of <method namespace="HTTPProd" class="TBasePageProducer">TBasePageProducer</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="TBasePageProducer">Create</method> to create and initialize an instance of <method namespace="HTTPProd" class="TBasePageProducer">TBasePageProducer</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AOwner is a component, typically a Web module, that is responsible for freeing the page producer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the Web module context object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPProd" class="TBasePageProducer">WebModuleContext</property> to get access to the T<property namespace="HTTPProd" class="TBasePageProducer">WebModuleContext</property> object. The T<property namespace="HTTPProd" class="TBasePageProducer">WebModuleContext</property> object maintains a list of named variables that the producer uses when translating HTML-transparent tags.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies whether to strip quotation marks when extracting the parameters from an HTML-transparent tag.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="TBasePageProducer">StripParamQuotes</property> to indicate whether the page producer should strip quotation marks from the parameters of HTML-transparent tags before handling the tags. By setting <property namespace="HTTPProd" class="TBasePageProducer">StripParamQuotes</property> to true, the page producer compensates for HTML editors that automatically insert quotation marks around the values of tag options.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.ScriptEngine">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Names the script engine that generates or interprets script embedded in the documents that this producer creates.</para>
<property namespace="HTTPProd" class="TBasePageProducer">ScriptEngine</property> indicates the scripting language that the producer uses in its generated documents. For example, if the producer generates code that includes jscript, the value of <property namespace="HTTPProd" class="TBasePageProducer">ScriptEngine</property> is 'JSCRIPT'.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="HTTPProd" class="TBasePageProducer">ScriptEngine</property> is defined, the page producer generates its content using a special script-producer component. When <property namespace="HTTPProd" class="TBasePageProducer">ScriptEngine</property> is not defined, the page producer uses only the OnHTMLTag event, plus any other built-in translations provided by a descendant class. </para>
</comments>
</member>
<member name="E:HTTPProd.HTTPProd.OnHTMLTag">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the page producer needs to interpret the value of an HTML-transparent tag in the HTML template.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="HTTPProd" class="TBasePageProducer">OnHTMLTag</event> event handler to convert an HTML-transparent tag into the corresponding HTML commands that can be interpreted by a Web browser. If an <event namespace="HTTPProd" class="TBasePageProducer">OnHTMLTag</event> event is not supplied, the HTML-transparent tags in the HTML template will be replaced by empty strings.</para>
<para>The sequence of HTML that the event handler produces for an HTML-transparent tag can contain HTML-transparent tags for another page producer to convert. For example, one page producer might have a template that represents the format of the final HTTP response. It could read the HTTP request and for each section in the request assemble a set of HTML-transparent tags with parameters based on the request. Another page producer might take the content of the first page producer, and interpret those parameters.</para>
<class namespace="HTTPProd">TCustomPageProducer</class> is the base class for objects that produce a string of HTML commands based on an input template.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPProd">TCustomPageProducer</class> as a base class when defining an object that converts an HTML template into a string of HTML commands which can be interpreted by a client application such as a Web browser. HTML templates include HTML commands and HTML-transparent tags that are replaced with customized content by the page producer.</para>
<method namespace="HTTPProd" class="TCustomPageProducer">Create</method>s an instance of <method namespace="HTTPProd" class="TCustomPageProducer">TCustomPageProducer</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPProd" class="TCustomPageProducer">Create</method> to create and initialize an instance of <method namespace="HTTPProd" class="TCustomPageProducer">TCustomPageProducer</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited constructor, <method namespace="HTTPProd" class="TCustomPageProducer">Create</method> allocates the TStrings object that implements the HTMLDoc property.</para>
<method namespace="HTTPProd" class="TCustomPageProducer">Destroy</method>s an instance of <method namespace="HTTPProd" class="TCustomPageProducer">TCustomPageProducer</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="HTTPProd" class="TCustomPageProducer">Destroy</method> directly in an application. Instead, call Free. Free checks that the page producer reference is not nil, and only then calls <method namespace="HTTPProd" class="TCustomPageProducer">Destroy</method>.</para>
<method namespace="HTTPProd" class="TCustomPageProducer">Destroy</method> frees the TStrings object implements the HTMLDoc property before calling the inherited destructor.</para>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.HTMLDoc">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the HTML template used to generate the value returned by the Content method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="TCustomPageProducer">HTMLDoc</property> to a set of strings that make up the HTML template. Each string is a sequence of one or more HTML commands or HTML-transparent tags. An HTML-transparent tag has the form</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A pound sign (#) immediately follows the opening angle bracket (<) with no spaces separating it from the angle bracket. The pound sign identifies the string to the page producer as an HTML-transparent tag. The tag name immediately follows the pound sign with no spaces separating it from the pound sign. The page producer converts the entire HTML-transparent tag into true HTML commands based on the value of the tag name. Following the tag name, the HTML-transparent tag can optionally include parameters that specify details of the conversion to be performed. Each parameter is of the form ParamName=Value, where there is no space between the parameter name, the equals symbol (=) and the value. Each parameter is delimited by white space.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The angle brackets (< >) make the tag transparent to HTML browsers that do not recognize the #TagName construct.</para>
<para>Setting <property namespace="HTTPProd" class="TCustomPageProducer">HTMLDoc</property> clears the HTMLFile property.</para>
</note>
</comments>
</member>
<member name="P:HTTPProd.HTTPProd.HTMLFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of a file that contains the HTML template used to generate the value returned by the Content method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPProd" class="TCustomPageProducer">HTMLFile</property> to the name of the file that contains an HTML template. The HTML template is a sequence of HTML commands and HTML-transparent tags. An HTML-transparent tag has the form</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A pound sign (#) immediately follows the opening angle bracket (<) with no spaces separating it from the angle bracket. The pound sign identifies the string to the page producer as an HTML-transparent tag. The tag name immediately follows the pound sign with no spaces separating it from the pound sign. The page producer converts the entire HTML-transparent tag into true HTML commands based on the value of the tag name. Following the tag name, the HTML-transparent tag can optionally include parameters that specify details of the conversion to be performed. Each parameter is of the form ParamName=Value, where there is no space between the parameter name, the equals symbol (=) and the value. Each parameter is delimited by white space.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The angle brackets (< >) make the tag transparent to HTML browsers that do not recognize the #TagName construct.</para>
<para>When distributing applications that contain page producers which use the <property namespace="HTTPProd" class="TCustomPageProducer">HTMLFile</property> property, be sure to distribute the file along with the application. Also, be sure that the value of <property namespace="HTTPProd" class="TCustomPageProducer">HTMLFile</property> does not include a hard-coded path name that will not be available on the user's disk.</para>
<class namespace="HTTPProd">TPageProducer</class> produces a string of HTML commands based on an input template.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPProd">TPageProducer</class> to convert an HTML template into a string of HTML commands that can be interpreted by a client application such as a Web browser. In Web Broker applications, HTML templates include HTML commands and HTML-transparent tags that are replaced with customized content by the OnHTMLTag event. WebSnap application page templates often include server-side scripting (such as JScript or JavaScript) to dynamically generate content.</para>
<condition language="CBuilder">Do not create instances of <method namespace="HTTPProd" class="TAbstractScriptProducer">TAbstractScriptProducer</method>. Instead, construct descendants of <method namespace="HTTPProd" class="TAbstractScriptProducer">TAbstractScriptProducer</method> using the new keyword, passing any arguments for the descendant object's constructor.</condition>
<condition language="CBuilder">Descendant objects usually define a constructor that creates the particular kind of object and initializes its data.</condition>
<condition language="CBuilder">If an exception escapes from a constructor, the object's destructor is called to clean up the failed instance.</condition>
<class namespace="HTTPApp">TWebRequest</class> is the base class for all objects that represent client request information that is passed to a Web server application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use a descendant of <class namespace="HTTPApp">TWebRequest</class> to interpret an HTTP request message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Web application objects create <class namespace="HTTPApp">TWebRequest</class> objects to capture client requests. The properties of the <class namespace="HTTPApp">TWebRequest</class> objects are obtained from the HTTP request message. The Web application uses <class namespace="HTTPApp">TWebRequest</class> objects to create corresponding TWebResponse objects. The TWebDispatcher for the application then invokes the TWebActionItem that is associated with the PathInfo of the <class namespace="HTTPApp">TWebRequest</class> object.</para>
<class namespace="HTTPApp">TWebRequest</class> has several descendants which represent client requests for different types of Web server applications. These descendants are</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TApacheRequest objects for Apache server applications.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TCGIRequest objects for CGI server applications.</para>
<condition os="Windows">TWinCGIRequest objects for Windows-based CGI servers (Windows only).</condition>
</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.ReadClient">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype for a method to read from the HTTP request into a buffer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method> implement <method namespace="HTTPApp" class="TWebRequest">ReadClient</method>. <method namespace="HTTPApp" class="TWebRequest">ReadClient</method> is used to read content information from the HTTP request. Use <method namespace="HTTPApp" class="TWebRequest">ReadClient</method> to get the next chunk of information when the content of the request message is too large for the Content property. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Buffer to provide a buffer to contain the content information. Use Count to specify the number of bytes to read. <method namespace="HTTPApp" class="TWebRequest">ReadClient</method> returns the number of bytes actually read.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.ReadString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype for a method to read Count bytes from the HTTP request into a string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method> implement <method namespace="HTTPApp" class="TWebRequest">ReadString</method>. <method namespace="HTTPApp" class="TWebRequest">ReadString</method> is used to load content information from the HTTP request into a string. Use <method namespace="HTTPApp" class="TWebRequest">ReadString</method> to get the next chunk of information when the content of the request message is too large for the Content property.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.TranslateURI">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype for a method to translate a Uniform Resource Identifier (URI) into an internal representation of a location on the server.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method> implement <method namespace="HTTPApp" class="TWebRequest">TranslateURI</method>. <method namespace="HTTPApp" class="TWebRequest">TranslateURI</method> is used to translate the URI specified in a client request into a format that can be used by the server application. <method namespace="HTTPApp" class="TWebRequest">TranslateURI</method> is not relevant to CGI applications. </para>
<condition os="Windows">On Windows, the internal format varies, depending on whether the server application is an ISAPI or NSAPI application.</condition>
</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.WriteClient">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype for a method to write Count bytes from Buffer back to the HTTP client.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method> implement <method namespace="HTTPApp" class="TWebRequest">WriteClient</method>. <method namespace="HTTPApp" class="TWebRequest">WriteClient</method> is used by TWebResponse to send the contents of a response to the Web client.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.WriteString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype for a method to write the string AString back to the HTTP client.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method> implement <method namespace="HTTPApp" class="TWebRequest">WriteString</method>. <method namespace="HTTPApp" class="TWebRequest">WriteString</method> is used by TWebResponse to send the contents of a response to the Web client.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.WriteHeaders">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype for a method to write an HTTP header string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="HTTPApp" class="TWebRequest">WriteHeaders</method> to write an HTTP header string.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.GetFieldByName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype for a method that returns the value of the HTTP header variable specified by the Name parameter.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method> implement <method namespace="HTTPApp" class="TWebRequest">GetFieldByName</method> to provide access to arbitrary header fields in the HTTP request message. Use <method namespace="HTTPApp" class="TWebRequest">GetFieldByName</method> to read the value of an HTTP header variable that is not surfaced as one of the properties of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method>. For information on possible HTTP request header variables, see the current Internet standards documents.</para>
<method namespace="HTTPApp" class="TWebRequest">Create</method>s an instance of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications shouldn't need to call <method namespace="HTTPApp" class="TWebRequest">Create</method> to instantiate a request object. The TWebApplication object creates a <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method> object whenever it receives a client request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract prototype for a method to write a pure virtual method for updating the client method type.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="HTTPApp" class="TWebRequest">UpdateMethodType</method> to update the type of response that is requested by the Web client.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.ExtractFields">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Parses a multi-valued string into its constituent fields.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebRequest">ExtractFields</method> to parse a multi-valued HTTP header into separate strings for each value. For example, if the separator character of the UserAgent property is known, <method namespace="HTTPApp" class="TWebRequest">ExtractFields</method> can parse this property into separate UserAgent values.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Separators is a set of characters that are used to separate individual values within the multi-valued string. WhiteSpace is a set of characters that are to be ignored when parsing the string. Content is the multi-valued string to be parsed. Strings is the TStrings object that receives the individual values that are parsed from Content.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Parses the Content property into its constituent fields.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebRequest">ExtractContentFields</method> to fill the Strings parameter with the individual fields in the Content property. <method namespace="HTTPApp" class="TWebRequest">ExtractContentFields</method> assumes that fields are separated by ampersands (&). This is the format used when the MethodType is mtPost. If the Content property is not assigned, <method namespace="HTTPApp" class="TWebRequest">ExtractContentFields</method> does nothing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Parses the Cookie property into its constituent fields.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebRequest">ExtractCookieFields</method> to fill the Strings parameter with the individual fields in the Cookie property. <method namespace="HTTPApp" class="TWebRequest">ExtractCookieFields</method> assumes that fields are separated by semicolons. If the Cookie property is not assigned, <method namespace="HTTPApp" class="TWebRequest">ExtractCookieFields</method> does nothing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Parses the Query property into its constituent fields.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebRequest">ExtractQueryFields</method> to fill the Strings parameter with the individual fields in the Query property. <method namespace="HTTPApp" class="TWebRequest">ExtractQueryFields</method> assumes that fields are separated by ampersands (&). If the Query property is not assigned, <method namespace="HTTPApp" class="TWebRequest">ExtractQueryFields</method> does nothing.</para>
<method namespace="HTTPApp" class="TWebRequest">Destroy</method>s an instance of <method namespace="HTTPApp" class="TWebRequest">TWebRequest</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="HTTPApp" class="TWebRequest">Destroy</method>. When the request message is fully handled, TWebApplication destroys the request object by calling its Free method.</para>
<method namespace="HTTPApp" class="TWebRequest">Destroy</method> frees the TStrings objects used to represent the ContentFields, CookieFields, and QueryFields properties.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentParser">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Refers to the object's content parser object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">ContentParser</property> to locate the <property namespace="HTTPApp" class="TWebRequest">TWebRequest</property> instance's TAbstract<property namespace="HTTPApp" class="TWebRequest">ContentParser</property> object. The TAbstract<property namespace="HTTPApp" class="TWebRequest">ContentParser</property> is responsible for parsing the HTTP request.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentFields">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the parsed content of a POST request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">ContentFields</property> to read the fields of an HTTP request message when the MethodType is mtPost. The Content of the HTTP request is parsed, separating into fields at the ampersand character. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each field appears as a separate string in the <property namespace="HTTPApp" class="TWebRequest">ContentFields</property> list with the form Name=Value. As a TStrings object, <property namespace="HTTPApp" class="TWebRequest">ContentFields</property> allows applications to manipulate the individual fields by name or value.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.CookieFields">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the parsed contents of the Cookie header of an HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">CookieFields</property> to work with individual "cookie" strings provided by the Web client request. The Cookie property is parsed into separate fields by separating into substrings whenever a semicolon is encountered.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Cookie strings are used to track state information in a Web application. Each field appears as a separate string in the <property namespace="HTTPApp" class="TWebRequest">CookieFields</property> list with the form Name=Value. As a TStrings object, <property namespace="HTTPApp" class="TWebRequest">CookieFields</property> allows applications to manipulate the individual fields by name or value.</para>
<para>Applications can give state variables any name except one of the reserved cookie field names. See the Netscape documentation for a list of reserved cookie field names and their meanings.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.QueryFields">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the parsed contents of the Query in the URL of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">QueryFields</property> to work with individual query values provided by the Web client request. The Query property is parsed into separate fields by separating into substrings whenever an ampersand is encountered.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each query field appears as a separate string in the <property namespace="HTTPApp" class="TWebRequest">QueryFields</property> list with the form Name=Value. As a TStrings object, <property namespace="HTTPApp" class="TWebRequest">QueryFields</property> allows applications to manipulate the individual fields by name or value.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ProtocolVersion">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the version number of the HTTP protocol specified in the initial header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">ProtocolVersion</property> to determine the protocol used by the Web client when generating the HTTP request message. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Some properties of the HTTP request may be interpreted differently depending on the <property namespace="HTTPApp" class="TWebRequest">ProtocolVersion</property>. For example, if <property namespace="HTTPApp" class="TWebRequest">ProtocolVersion</property> is 1.0, then the connection should not be considered persistent, even if the Connection property does not specify the close option.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.URL">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the Uniform Resource Identifier (URI) specified by the HTTP request message to identify the target of the request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the <property namespace="HTTPApp" class="TWebRequest">URL</property> property to identify the resource the Web client identifies as the target of the request message. <property namespace="HTTPApp" class="TWebRequest">URL</property> may be an HTML page to return, a resource to be created or deleted, or an object that provides some other service for the Web client. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="HTTPApp" class="TWebRequest">TWebRequest</property> object parses the <property namespace="HTTPApp" class="TWebRequest">URL</property> into its constituent parts, yielding the Host, ScriptName, PathInfo, and Query properties.</para>
<para>Usually the <property namespace="HTTPApp" class="TWebRequest">URL</property> property is a Uniform Resource Locator (<property namespace="HTTPApp" class="TWebRequest">URL</property>) that can be parsed into host, script, path, and query portions. However, it is possible for HTTP request messages to specify the target in more general terms, as a Uniform Resource Identifier (URI).</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Query">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the value of the query information (if any) of the URL specified in the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">Query</property> to determine the details of a query specified in the URL of the Web client request. For example, given this URL:</para>
<property namespace="HTTPApp" class="TWebRequest">Query</property> is the unparsed query portion of the URL. The query may include multiple fields separated by ampersands. Use the <property namespace="HTTPApp" class="TWebRequest">Query</property>Fields property to work with the query on a field-by-field basis.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.PathInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the path information (if any) of the URL specified in the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">PathInfo</property> to determine the path on the server machine where the target of the request is found. For example, given this URL:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The TWebDispatcher object uses the <property namespace="HTTPApp" class="TWebRequest">PathInfo</property> to identify the appropriate TWebActionItem for servicing the request message.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.PathTranslated">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents a translation of the PathInfo property to a fully qualified path on the Web server.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">PathTranslated</property> to refer to the location of the target of the request in an HTTP response.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Authorization">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Authorization</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">Authorization</property> to check whether the client that sent the request message has provided the correct authentication information. <property namespace="HTTPApp" class="TWebRequest">Authorization</property> allows the Web application to provided limited access to the resource specified by the URL property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information about HTTP authentication schemes, see the Internet standards documentation.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.CacheControl">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the Cache-Control header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">CacheControl</property> to determine any Web client directives that must be obeyed by all caching mechanisms along the request/response chain. The <property namespace="HTTPApp" class="TWebRequest">CacheControl</property> directives of the HTTP request need not apply to the corresponding HTTP response. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HTTP 1.1 standard defines the following directives for <property namespace="HTTPApp" class="TWebRequest">CacheControl</property>:</para>
<para>The request may not be cached. The Web server validates the request before the TWebRequest object is created.</para>
</td>
</tr>
<tr>
<td>
<para>no-store</para>
</td>
<td>
<para>The request contains sensitive information and may not be stored on any permanent medium such as a backup tape. If the request is stored temporarily in a file, the file must be deleted.</para>
</td>
</tr>
<tr>
<td>
<para>max-age=ss</para>
</td>
<td>
<para>The request is considered invalid if it is older than ss seconds. This directive takes precedence over the Expires property, even if Expires is more restrictive. Invalid requests are validated by the Web server before the TWebRequest object is created.</para>
</td>
</tr>
<tr>
<td>
<para>max-stale or max-stale=ss</para>
</td>
<td>
<para>The client is willing to accept a response that has exceeded its expiration time. The max-stale directive can optionally specify the number of seconds by which the response can exceed its expiration time.</para>
</td>
</tr>
<tr>
<td>
<para>min-fresh=ss</para>
</td>
<td>
<para>The client is not willing to accept a response that expires in less than ss seconds.</para>
</td>
</tr>
</table>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Cookie">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Cookie</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">Cookie</property> to read the "cookie" strings provided in the Web client request. <property namespace="HTTPApp" class="TWebRequest">Cookie</property> strings are used to track state information in a Web application. <property namespace="HTTPApp" class="TWebRequest">Cookie</property> is the unparsed value of the <property namespace="HTTPApp" class="TWebRequest">Cookie</property> header. The <property namespace="HTTPApp" class="TWebRequest">Cookie</property> header can include multiple fields separated by semicolons. Use the <property namespace="HTTPApp" class="TWebRequest">Cookie</property>Fields property to work with the <property namespace="HTTPApp" class="TWebRequest">Cookie</property> header on a field-by-field basis.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Date">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Date</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">Date</property> to determine the date and time at which the HTTP request message originated. <property namespace="HTTPApp" class="TWebRequest">Date</property> can be used to determine whether the Content of the request is still valid. The value of <property namespace="HTTPApp" class="TWebRequest">Date</property> is translated into local time as specified by the system clock from the time units set by the Web client.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, if an HTTP request message specifies a MethodType of mtPost, and <property namespace="HTTPApp" class="TWebRequest">Date</property> is older than the most recent values of the fields that are being posted, the server application may return a status code that indicates an error rather than overwriting more recent values.</para>
<property namespace="HTTPApp" class="TWebRequest">Date</property> is represented using the T<property namespace="HTTPApp" class="TWebRequest">Date</property>Time type. The integral part of a T<property namespace="HTTPApp" class="TWebRequest">Date</property>Time value is the number of days that have passed since Dec. 30 1899. The fractional part of a T<property namespace="HTTPApp" class="TWebRequest">Date</property>Time value is the fraction of a 24-hour day that has elapsed.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Accept">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Accept</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">Accept</property> to determine the media types the Web client can accept in response to the request. Not every HTTP request message has an <property namespace="HTTPApp" class="TWebRequest">Accept</property> header. If the <property namespace="HTTPApp" class="TWebRequest">Accept</property> property is not set, then any media type is potentially acceptable in the response.</para>
<property namespace="HTTPApp" class="TWebRequest">Accept</property> headers usually indicate that the response should be limited to a small set of desired types. For example, a Web client requesting an audio response might produce a <property namespace="HTTPApp" class="TWebRequest">TWebRequest</property> object with <property namespace="HTTPApp" class="TWebRequest">Accept</property> set to the following string:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">This request indicates that the preferred response media type is audio/basic, but that any audio type is acceptable if it is the best available after an 80% markdown in quality.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For information on the format of <property namespace="HTTPApp" class="TWebRequest">Accept</property> headers, see the current Internet standards documentation.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.From">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">From</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">From</property> to determine the Internet e-mail address of the human user for whom the Web client sent the HTTP request message. This value can be used for logging purposes, or to contact the originator of the request if problems occur.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Host">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Host</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">Host</property> to determine the Internet host and port number of resource being requested. For example, if the client request specifies the following URL:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="HTTPApp" class="TWebRequest">Host</property> would be </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="HTTPApp" class="TWebRequest">Host</property> can be used to differentiate between internally ambiguous URLs, such as the root "/" URL of a server for multiple host names on a single IP address.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.IfModifiedSince">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the If-Modified-Since header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">IfModifiedSince</property> on a request with a MethodType of mtGet to determine whether the request is conditional. If the information requested by the Web client was not modified since the time indicated by <property namespace="HTTPApp" class="TWebRequest">IfModifiedSince</property>, the response should be a not modified error rather than the information indicated by the URL property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="HTTPApp" class="TWebRequest">IfModifiedSince</property> is given according to the local clock, not the clock of the Web client.</para>
<property namespace="HTTPApp" class="TWebRequest">IfModifiedSince</property> is represented using the TDateTime type. The integral part of a TDateTime value is the number of days that have passed since Dec. 30, 1899. The fractional part of a TDateTime value is the fraction of a 24-hour day that has elapsed.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Referer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Referer</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">Referer</property> to determine the URI of the resource where the HTTP request message originated. <property namespace="HTTPApp" class="TWebRequest">Referer</property> allows the server application to generate back-links to the source of the request. If <property namespace="HTTPApp" class="TWebRequest">Referer</property> is a partial URI, it should be interpreted as a relative path to the URL property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="HTTPApp" class="TWebRequest">Referer</property> property is not set when the URL of the HTTP request was obtained from a source that does not have its own URI, such as input from the user keyboard.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.UserAgent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the User-Agent header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">UserAgent</property> to obtain information about the user agent originating the client request. Use the <property namespace="HTTPApp" class="TWebRequest">UserAgent</property> information for statistical purposes, for tracing protocol violations, and for tailoring responses to known limitations of specific applications that generate client requests. The <property namespace="HTTPApp" class="TWebRequest">UserAgent</property> string contains one or more descriptors, in order of significance. Each descriptor gives the name of the product or application that generated the request, or a comment about the user agent.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentEncoding">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the Content-Encoding header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">ContentEncoding</property> to determine what encoding mechanisms, if any, have been applied to the Content of the HTTP request. The encoding mechanisms are listed in the order in which the Web client applied them, separated by commas. Typically, <property namespace="HTTPApp" class="TWebRequest">ContentEncoding</property> indicates a compression method or an encoding scheme used to transfer extended ASCII characters over the net.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reverse the <property namespace="HTTPApp" class="TWebRequest">ContentEncoding</property> mechanisms to decode the Content into the form indicated by the ContentType property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the Content-Type header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">ContentType</property> to determine the media type of the Content of the HTTP request message. The <property namespace="HTTPApp" class="TWebRequest">ContentType</property> is a string of the form Type/SubType.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Most HTTP requests do not require any Content at all. For most requests with a Method that requires a value for Content, the <property namespace="HTTPApp" class="TWebRequest">ContentType</property> is text/html. However, HTTP requests for server-specific values of Method can use any media type appropriate to the request.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentLength">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the Content-Length header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read the <property namespace="HTTPApp" class="TWebRequest">ContentLength</property> property to determine the length of the Content property. <property namespace="HTTPApp" class="TWebRequest">ContentLength</property> allows an application to determine the end of the Content property when the ContentType is not text/html. A <property namespace="HTTPApp" class="TWebRequest">ContentLength</property> of 0 indicates that the length of the Content property is not determined, either because the request does not include any Content, or because the Web client did not know the length. </para>
<para>The length of the Content may be less than <property namespace="HTTPApp" class="TWebRequest">ContentLength</property> when the Content is passed using chunked transfer coding.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentVersion">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the Content-Version header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">ContentVersion</property> to determine the version of the Content of the HTTP request message. Most HTTP requests do not require any Content at all. When the Method requires a value for Content, the <property namespace="HTTPApp" class="TWebRequest">ContentVersion</property> may be set to indicate the version of the source of that content. The format of the <property namespace="HTTPApp" class="TWebRequest">ContentVersion</property> depends on the ContentType of the request.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Content">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the unparsed contents of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">Content</property> to read the contents of an HTTP request message that is sending information to the server. The value of <property namespace="HTTPApp" class="TWebRequest">Content</property> depends on the Method of the HTTP request. When the Method is POST, <property namespace="HTTPApp" class="TWebRequest">Content</property> is the unparsed string giving the values to be posted with their associated fields. When the Method is PUT, <property namespace="HTTPApp" class="TWebRequest">Content</property> is the value that should replace the URL given by the URL property.</para>
<para>When the Method is POST, the parsed version of the post request is available in the <property namespace="HTTPApp" class="TWebRequest">Content</property>Fields property.</para>
<para>If the content of a message is particularly large, it is transferred in chunks. In this case, the <property namespace="HTTPApp" class="TWebRequest">Content</property> property does not contain the entire message content. To read the rest of the content, use the ReadClient method. </para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Connection">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Connection</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">Connection</property> to determine the options requested by the Web client for its connection to the server application. The HTTP 1.1 standard specifies only one value for the <property namespace="HTTPApp" class="TWebRequest">Connection</property> header. If the value of <property namespace="HTTPApp" class="TWebRequest">Connection</property> is close, the connection should be closed after the completion of the response.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.DerivedFrom">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the Derived-From header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">DerivedFrom</property> to determine the URI from which the value of Content originated. <property namespace="HTTPApp" class="TWebRequest">DerivedFrom</property> is only meaningful when the request includes a Content property and the Content did not originate with the Web client.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Expires">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Expires</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">Expires</property> to determine whether the request is "stale." <property namespace="HTTPApp" class="TWebRequest">Expires</property> is the date and time at which the request becomes invalid. The value of <property namespace="HTTPApp" class="TWebRequest">Expires</property> is translated into local time as specified by the system clock from the time units set by the Web client.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the request has a CacheControl value with a max-age directive, the max-age directive overrides the value of <property namespace="HTTPApp" class="TWebRequest">Expires</property>.</para>
<property namespace="HTTPApp" class="TWebRequest">Expires</property> is represented using the TDateTime type. The integral part of a TDateTime value is the number of days that have passed since Dec. 30, 1899. The fractional part of a TDateTime value is the fraction of a 24-hour day that has elapsed.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Title">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the value of the <property namespace="HTTPApp" class="TWebRequest">Title</property> header of the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">Title</property> to determine the <property namespace="HTTPApp" class="TWebRequest">Title</property> of the information requested in the Web client request.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.RemoteAddr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the remote IP address of the client associated with the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">RemoteAddr</property> to obtain the IP address of the source of the Web client request.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.RemoteHost">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the fully qualified reverse domain lookup of the client associated with the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebRequest">RemoteHost</property> to compose URI values for back-links to the source of the request when the Referer property is not specified. <property namespace="HTTPApp" class="TWebRequest">RemoteHost</property> does not include any path information.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ScriptName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the value of the script information (if any) of the URL specified in the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">ScriptName</property> to determine the full path to the Web server application specified by the client request. For example, given this URL:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the port number of the port on the Web server that receives the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebRequest">ServerPort</property> to determine the number of the port used in the connection to the Web server. The Host property will include the <property namespace="HTTPApp" class="TWebRequest">ServerPort</property> if it is specified as part of the URL for the client request.</para>
<property namespace="HTTPApp" class="TWebRequest">InternalPathInfo</property> contains the path information portion of the URL, which identifies the destination of the message. This property generally contains the same information as PathInfo.<condition os="Linux"/>To ensure cross-platform code compatibility, use <property namespace="HTTPApp" class="TWebRequest">InternalPathInfo</property> instead of PathInfo.</para>
<para>On Windows, this property varies slightly from PathInfo if the application has an embedded test server. In that case, information specific to the test server is contained in the InternalScriptName instead of the <property namespace="HTTPApp" class="TWebRequest">InternalPathInfo</property>. </para>
<property namespace="HTTPApp" class="TWebRequest">InternalScriptName</property> contains the script name portion of the URL, which specifies the name of a Web server application. This property generally contains the same information as ScriptName. To ensure cross platform code compatibility, use <property namespace="HTTPApp" class="TWebRequest">InternalScriptName</property> instead of ScriptName.</para>
<para>On Windows, this property varies slightly from ScriptName if the application has an embedded test server. In that case, information specific to the test server is contained in the <property namespace="HTTPApp" class="TWebRequest">InternalScriptName</property> instead of the InternalPathInfo. </para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Files">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the files uploaded in the HTTP request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use this property to find the specific instance of the object's TAbstractRequest<property namespace="HTTPApp" class="TWebRequest">Files</property> object. The TAbstractRequest<property namespace="HTTPApp" class="TWebRequest">Files</property> object contains uploaded files extracted from the HTTP request.</para>
<class namespace="HTTPApp">TAbstractContentParser</class> is the base class for objects that parse the content of an HTTP request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Web request objects use a descendant of <class namespace="HTTPApp">TAbstractContentParser</class> to retrieve information about the named values in the content of the HTTP request they represent. <class namespace="HTTPApp">TAbstractContentParser</class> defines two protected methods, GetContentFields and GetFiles, which the Web request uses to obtain values for its ContentFields and Files properties, respectively.</para>
<class namespace="HTTPApp">TAbstractContentParser</class> should not be instantiated. The GetContentFields and GetFiles methods are abstract or, in C++ terminology, pure virtual, which means that <class namespace="HTTPApp">TAbstractContentParser</class> does not supply an implementation. Each <class namespace="HTTPApp">TAbstractContentParser</class> descendant overrides these methods to support its own method of extracting named value strings and uploaded files from an HTTP request. The <class namespace="HTTPApp">TAbstractContentParser</class> descendant also overrides the public CanParse method to check whether the request message contains information encoded in a way that the content parser understands.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each <class namespace="HTTPApp">TAbstractContentParser</class> descendant registers itself with the Web server application. Then, when a Web request object needs to parse its content to set the ContentFields and Files properties, it searches through the registered content parsers to locate the most recently registered parser that can parse the current content. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the named value strings that are included in the content of the current Web request.</para>
<method namespace="HTTPApp" class="TAbstractContentParser">GetContentFields</method> returns a list of strings with the form "Name=Value" that represent any name/value pairs that the parser identifies in the content of the current Web request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TAbstractContentParser">TAbstractContentParser</method>, <method namespace="HTTPApp" class="TAbstractContentParser">GetContentFields</method> is abstract or, in C++ terminology, pure virtual, meaning that this class does not supply an implementation. Descendant classes override this method to extract name/value pairs from the current request and add them to the returned string list.</para>
<para>The content parser owns the string list it returns. The caller should not free the string list.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.GetFiles">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a set of uploaded files that the parser extracts from the current Web request.</para>
<method namespace="HTTPApp" class="TAbstractContentParser">GetFiles</method> returns a list of Web request file objects, each of which represents an uploaded file from the current Web request. Each Web request file object has properties to describe an uploaded file, including a stream object from which to read the content of the uploaded file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TAbstractContentParser">TAbstractContentParser</method>, <method namespace="HTTPApp" class="TAbstractContentParser">GetFiles</method> is abstract or, in C++ terminology, pure virtual, meaning that this class does not supply an implementation. Descendant classes override this method to extract uploaded files from the current request and add them to the Web request files object.</para>
<para>The content parser owns the list it returns. The caller should not free this list.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.CanParse">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether a specified request message contains information encoded in a way that this parser understands. </para>
<method namespace="HTTPApp" class="TAbstractContentParser">CanParse</method> indicates whether a content parser class can handle parsing a specified request message. <method namespace="HTTPApp" class="TAbstractContentParser">CanParse</method> is a class method (Delphi) or static method (C++), which means the Web request does not need an instantiated object to call this method. The Web request object calls the <method namespace="HTTPApp" class="TAbstractContentParser">CanParse</method> method of every registered <method namespace="HTTPApp" class="TAbstractContentParser">TAbstractContentParser</method> descendant until it finds one that can parse its content.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AWebRequest is the current HTTP request message.</para>
<method namespace="HTTPApp" class="TAbstractContentParser">CanParse</method> returns true if this class can parse AWebRequest, false if AWebRequest does not indicate an encoding that this class understands.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TAbstractContentParser">TAbstractContentParser</method>, <method namespace="HTTPApp" class="TAbstractContentParser">CanParse</method> always returns false. Descendant classes that implement the GetContentFields and GetFiles methods override <method namespace="HTTPApp" class="TAbstractContentParser">CanParse</method> to indicate when a Web request has a format they can parse.</para>
<method namespace="HTTPApp" class="TAbstractContentParser">Create</method>s and initializes a new <method namespace="HTTPApp" class="TAbstractContentParser">TAbstractContentParser</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <method namespace="HTTPApp" class="TAbstractContentParser">TAbstractContentParser</method>. This class and its descendants are intended only as helper objects to the Web request. The Web request creates its own instance of a <method namespace="HTTPApp" class="TAbstractContentParser">TAbstractContentParser</method> descendant that can parse its content.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AWebRequest is the Web request object that creates this content parser to extract information from its content. This becomes the value of the WebRequest property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.WebRequest">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the Web request object that uses this parser to parse its content.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Content parsers use the protected <property namespace="HTTPApp" class="TAbstractContentParser">WebRequest</property> property internally to access the content they parse. The value of <property namespace="HTTPApp" class="TAbstractContentParser">WebRequest</property> is a Web request object whose properties represent the headers and content of the current HTTP request message.</para>
<class namespace="HTTPApp">TContentParser</class> is the default parser for extracting named value strings and uploaded files from an HTTP request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Web request objects use a <class namespace="HTTPApp">TContentParser</class> object to parse the content of an HTTP request message when there is no other registered content parser that knows how to interpret that content. The Web request uses the content parser to assign values for its ContentFields and Files properties.</para>
<class namespace="HTTPApp">TContentParser</class> does not know how to parse special request formats. It simply calls the Web request object's own ExtractContentFields method to extract named value strings for the request's ContentFields property. It does not parse uploaded files, but merely returns an empty list for the request's Files property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the named value strings that are included in the content of the current Web request.</para>
<method namespace="HTTPApp" class="TContentParser">GetContentFields</method> returns a list of strings with the form "Name=Value" that represent any name/value pairs that the parser identifies in the content of the current Web request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TContentParser">TContentParser</method>, <method namespace="HTTPApp" class="TContentParser">GetContentFields</method> simply calls the ExtractContentFields method of the current Web request. This method assumes that fields are strings with the form "Name=Value", separated by ampersands (&).</para>
<para>The content parser owns the string list it returns. The caller should not free the string list.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.GetFiles">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a set of uploaded files that the parser extracts from the current Web request.</para>
<method namespace="HTTPApp" class="TContentParser">GetFiles</method> returns a list of Web request file objects, each of which represents an uploaded file from the current Web request. Each Web request file object has properties to describe an uploaded file, including a stream object from which to read the content of the uploaded file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TContentParser">TContentParser</method>, <method namespace="HTTPApp" class="TContentParser">GetFiles</method> always returns an empty list. That is, <method namespace="HTTPApp" class="TContentParser">TContentParser</method> does not implement support for uploaded files in HTTP requests.</para>
<para>The content parser owns the list it returns. The caller should not free this list.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.CanParse">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether a specified request message contains information encoded in a way that this parser understands. </para>
<method namespace="HTTPApp" class="TContentParser">CanParse</method> indicates whether a content parser class can handle parsing a specified request message. <method namespace="HTTPApp" class="TContentParser">CanParse</method> is a <condition language="CBuilder">static</condition>
<condition language="Delphi">class</condition> method, which means the Web request does not need an instantiated object to call this method. The Web request object calls the <method namespace="HTTPApp" class="TContentParser">CanParse</method> method of every registered content parser until it finds one that can parse its content.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AWebRequest is the current HTTP request message.</para>
<method namespace="HTTPApp" class="TContentParser">CanParse</method> returns true if this class can parse AWebRequest, false if AWebRequest does not indicate an encoding that this class understands.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TContentParser">TContentParser</method>, <method namespace="HTTPApp" class="TContentParser">CanParse</method> always returns true. <method namespace="HTTPApp" class="TContentParser">TContentParser</method> is always the last content parser that the Web request object checks, and provides the default parsing when no other parser is available.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Destroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Frees the memory associated with the <method namespace="HTTPApp" class="TContentParser">TContentParser</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not free content parser instances. The Web request object frees the content parser when it no longer needs it.</para>
<class namespace="HTTPApp">TAbstractWebRequestFiles</class> is the base class for objects that manage a set of Web request files objects (TAbstractWebRequestFile descendants). Each Web request file object in the collection describes an uploaded file that was extracted from the current HTTP request object.</para>
<class namespace="HTTPApp">TAbstractWebRequestFiles</class> should not be instantiated. The methods that implement its properties are abstract or, in C++ terminology, pure virtual. Instead, applications use a <class namespace="HTTPApp">TAbstractWebRequestFiles</class> descendant such as TWebRequestFiles (which is included in WebSnap).</para>
<para>Support for uploaded files is only included in WebSnap. For other Web server applications, this class exists only as a placeholder for the Files property on TWebRequest.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Items">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the uploaded files in the collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebRequestFiles">Items</property> to access the descriptions of the individual uploaded files in the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">I is the index of the file to access, where 0 indicates the first file, 1 indicates the second file, and so on. The value of I must be less than the value of the Count property.</para>
<property namespace="HTTPApp" class="TAbstractWebRequestFiles">Items</property> is the default property of <property namespace="HTTPApp" class="TAbstractWebRequestFiles">TAbstractWebRequestFiles</property>. This means that the property name can be omitted when using this property. Thus, the line</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of uploaded files in the collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebRequestFiles">Count</property> to determine the number of files in this collection. <property namespace="HTTPApp" class="TAbstractWebRequestFiles">Count</property> provides an upper bound to the index of the Items property.</para>
<class namespace="HTTPApp">TAbstractWebRequestFile</class> introduces properties to describe and provide access to an uploaded file from an HTTP request. These include</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">FileName, which gives the name of the uploaded file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">FieldName, which gives the name of the field whose value is the uploaded file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ContentType, which describes how the file data is encoded.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Stream, which is a stream object from which you can read the file content.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The methods that implement these properties are all abstract or, in C++ terminology, pure virtual. This means that the Web server application does not instantiate <class namespace="HTTPApp">TAbstractWebRequestFile</class>. Instead, it uses a <class namespace="HTTPApp">TAbstractWebRequestFile</class> descendant such as TWebRequestFile (which is included in WebSnap).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each <class namespace="HTTPApp">TAbstractWebRequestFile</class> descendant describes a single uploaded file. A collection of all the uploaded files from the current request is available as the Files property of TWebRequest. In addition, in WebSnap applications, adapter fields that work with uploaded files surface those files using a TUpdateFileList object or IActionFieldValues interface.</para>
<para>Support for uploaded files is only included in WebSnap. For other Web server applications, this class exists only as a placeholder for the Files property on TWebRequest.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.FieldName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the name of the adapter field whose value is the contents of the file.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebRequestFile">FieldName</property> to identify the adapter field for which this file was uploaded. This is the same as the <property namespace="HTTPApp" class="TAbstractWebRequestFile">FieldName</property> property of the adapter field object.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.FileName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the name of the uploaded file.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebRequestFile">FileName</property> to obtain the name of the uploaded file.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Stream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the contents of the uploaded file.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TAbstractWebRequestFile">Stream</property> to read the content of the uploaded file. Call the Read method of this stream to read the file contents.</para>
<para>The ContentType property indicates the format used to encode the file contents that you read from <property namespace="HTTPApp" class="TAbstractWebRequestFile">Stream</property>.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes how the file data is encoded.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebRequestFile">ContentType</property> to determine the format of the data you can read from the Stream property. <property namespace="HTTPApp" class="TAbstractWebRequestFile">ContentType</property> is a string of the format Type/SubType, which names the MIME type and subtype used to encode the file contents.</para>
<class namespace="HTTPApp">TCookie</class> represents a Cookie header in an HTTP response message. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPApp">TCookie</class> to specify the cookie header that should be sent with a response message when responding to an HTTP request message. Cookie headers contain state information that the Web client passes on to other locations on the Internet or Intranet.</para>
<method namespace="HTTPApp" class="TCookie">Create</method>s an instance of <method namespace="HTTPApp" class="TCookie">TCookie</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">It is seldom necessary to call the constructor for <method namespace="HTTPApp" class="TCookie">TCookie</method> directly. Instead, create <method namespace="HTTPApp" class="TCookie">TCookie</method> objects indirectly by calling the Add method of <method namespace="HTTPApp" class="TCookie">TCookie</method>Collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited constructor, <method namespace="HTTPApp" class="TCookie">Create</method> initializes the Expires property to indicate no expiration date.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.AssignTo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the properties of the <method namespace="HTTPApp" class="TCookie">TCookie</method> object to another <method namespace="HTTPApp" class="TCookie">TCookie</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the <method namespace="HTTPApp" class="TCookie">AssignTo</method> method for <method namespace="HTTPApp" class="TCookie">TCookie</method>. Instead, call the Assign method of the destination object. The Assign method of the destination object calls the <method namespace="HTTPApp" class="TCookie">AssignTo</method> method if it does not contain code for copying the properties of a <method namespace="HTTPApp" class="TCookie">TCookie</method> object. If the destination object is a <method namespace="HTTPApp" class="TCookie">TCookie</method> object, <method namespace="HTTPApp" class="TCookie">AssignTo</method> copies the Name, Value, Domain, Path, Expires, and Secure properties so the destination cookie generates the same Cookie header string.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Name">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the custom field represented by this Cookie header.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TCookie">Name</property> to the name that identifies the use of the Value property in the Cookie header. The Value property is combined with the <property namespace="HTTPApp" class="TCookie">Name</property> property into a string of the form <property namespace="HTTPApp" class="TCookie">Name</property>=Value. This string appears as one of the fields in the Cookie header represented by the HeaderValue property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Value">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the value of the Cookie header field named by the Name property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TCookie">Value</property> to the value associated with the field named by the Name property. The <property namespace="HTTPApp" class="TCookie">Value</property> property is combined with the Name property into a string of the form Name=<property namespace="HTTPApp" class="TCookie">Value</property>. This string appears as one of the fields in the Cookie header represented by the Header<property namespace="HTTPApp" class="TCookie">Value</property> property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Domain">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the <property namespace="HTTPApp" class="TCookie">Domain</property> field of the cookie header.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TCookie">Domain</property> to limit the recipients of the cookie header to certain domains. The Web client will only send this cookie on to URIs in the specified domain. To limit the recipients to certain paths within the specified domain, use the Path property. </para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Path">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies the paths of URLs to which the Cookie should be sent.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TCookie">Path</property> to limit the recipients of the cookie header to certain paths. The Web client will only send this cookie header on to URLs with the specified path. To limit the recipients to certain domains, use the Domain property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Expires">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies when the cookie is no longer valid.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TCookie">Expires</property> to the date and time after which the Web client should not send the cookie on with HTTP messages.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Secure">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the Web client must use a secure connection to pass on the Cookie header.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TCookie">Secure</property> to true if the Web client must use a secure connection when sending the Cookie header. <property namespace="HTTPApp" class="TCookie">Secure</property> connections are connections where messages may not be stored on any permanent medium such as a back-up tape. If the message is stored temporarily in a file, the file must be deleted.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TCookie">Secure</property> to false if it does not matter whether the Cookie header is sent using a secure connection.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.HeaderValue">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the Cookie header string that represents this <property namespace="HTTPApp" class="TCookie">TCookie</property> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TCookie">HeaderValue</property> to determine the Cookie header that is added to the HTTP response message for this <property namespace="HTTPApp" class="TCookie">TCookie</property> object. <property namespace="HTTPApp" class="TCookie">HeaderValue</property> combines the information specified by the Name and Value properties into a single Name=Value field, and then adds the Domain, Path, Expires, and Secure fields based on the values of the properties with the corresponding names.</para>
<class namespace="HTTPApp">TCookieCollection</class> is a collection of TCookie objects. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPApp">TCookieCollection</class> to represent all the Cookie headers of an HTTP response message. Each Cookie header is represented by a single TCookie object. A Cookie header includes a named field with an associated value, of the form Name=Value, plus a number of other, standard fields that specify the destination of the cookie, when the cookie is valid, and so on. Web clients pass Cookie headers on to the destinations specified by the fields of the Cookie header.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Add">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a new TCookie object and adds it to the end of the Items property array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TCookieCollection">Add</method> to add a new Cookie header to the set of cookie headers sent with the Web response message. Use <method namespace="HTTPApp" class="TCookieCollection">Add</method> when adding a Cookie header whose fields will be set at a later time. If the values of the TCookie properties are known at the time of creation, use the SetCookieField method of the Web response object instead.</para>
<method namespace="HTTPApp" class="TCookieCollection">Create</method>s and initializes a <method namespace="HTTPApp" class="TCookieCollection">TCookieCollection</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications should not need to call the <method namespace="HTTPApp" class="TCookieCollection">Create</method> method directly. The Web response object that uses the cookie collection to represent its Cookie headers creates the <method namespace="HTTPApp" class="TCookieCollection">TCookieCollection</method> object from its own constructor.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.WebResponse">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the T<property namespace="HTTPApp" class="TCookieCollection">WebResponse</property> object that uses the cookie collection to represent all of its Cookie headers.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TCookieCollection">WebResponse</property> to access the response object that is using the cookie collection. The response object is a descendant of T<property namespace="HTTPApp" class="TCookieCollection">WebResponse</property>, either <condition os="Windows">TISAPIResponse,</condition>
<condition os="Windows">TWinCGIResponse,</condition>TCGIResponse<condition os="Windows">,</condition> or TApacheResponse, depending on the type of Web server application.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the properties of the response object to obtain information about the other headers in the response message or the content of the response message. Many applications use this information to determine what field values to specify as Cookie headers.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Items">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides indexed access to the TCookie objects in the collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TCookieCollection">Items</property> to access the properties of the TCookie objects maintained by <property namespace="HTTPApp" class="TCookieCollection">TCookieCollection</property>. </para>
<para>In Delphi, items is the default property of <property namespace="HTTPApp" class="TCookieCollection">TCookieCollection</property>, so the name of the <property namespace="HTTPApp" class="TCookieCollection">Items</property> property can be left off when using this property. Thus the line</para>
<class namespace="HTTPApp">TWebResponse</class> is the base class for all objects that represent HTTP messages sent in response to an HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use a descendant of <class namespace="HTTPApp">TWebResponse</class> to specify the response to an HTTP request message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A web application creates a <class namespace="HTTPApp">TWebResponse</class> object based on the TWebRequest object for an incoming HTTP request message. The Web dispatcher for the application then passes the <class namespace="HTTPApp">TWebResponse</class> object to the TWebActionItem associated with the TWebRequest object, so that the response can be formulated.</para>
<class namespace="HTTPApp">TWebResponse</class> has descendants that represent HTTP response messages in different types of web server applications. These descendants are</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TApacheResponse objects in Apache server applications.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TCGIResponse objects in CGI server applications.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists of one or more comma-separated challenges provided when the request fails with StatusCode 401 (Unauthorized).</para>
<method namespace="HTTPApp" class="TWebResponse">FormatAuthenticate</method> returns the value of WWWAuthenticate if Realm is an empty string. If it is not empty, it returns a name/value pair describing the realm of the WWWAuthenticate property.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.GetCustomHeader">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the value of the custom header with the specified name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebResponse">GetCustomHeader</method> to obtain the value of one of the custom headers specified in the CustomHeaders property. The Name parameter specifies the name of the HTTP message header.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Sent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the HTTP response message has already been sent.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Because SendRedirect and SendStream are abstract (pure virtual) methods for <method namespace="HTTPApp" class="TWebResponse">TWebResponse</method>, <condition language="CBuilder">
</condition> always returns false. Descendants of <method namespace="HTTPApp" class="TWebResponse">TWebResponse</method> override <method namespace="HTTPApp" class="TWebResponse">Sent</method> to check whether the message was sent and return true or false as appropriate.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TWebApplication objects read <method namespace="HTTPApp" class="TWebResponse">Sent</method> and send unsent responses to the web client.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Create">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates an instance of <method namespace="HTTPApp" class="TWebResponse">TWebResponse</method> to represent the response to the HTTPRequest parameter.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications shouldn't need to call <method namespace="HTTPApp" class="TWebResponse">TWebResponse</method> to instantiate a response object. The TWebApplication object creates a <method namespace="HTTPApp" class="TWebResponse">TWebResponse</method> for each TWebRequest it creates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Appends the custom headers specified by the CustomHeaders property to the Headers parameter.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebResponse">AddCustomHeaders</method> to add the message headers described by the CustomHeaders property to a string of message headers. Each header is added on its own line (separated by carriage return and line feed), in the format HeaderName: Value.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.SendResponse">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype of a method that sends the HTTP response message to the web client.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebResponse">SendResponse</method> after setting the properties of the HTTP response object to specify the response that should be made to the web client. If the request should be redirected to another URI, it is more efficient to call SendRedirect instead.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.SendRedirect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype of a method that sends the response with a StatusCode of 301 (Moved Permanently) and a Location of URI.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebResponse">SendRedirect</method> to redirect the web client request to another URI that is the proper target of the request. <method namespace="HTTPApp" class="TWebResponse">SendRedirect</method> does the same thing as setting the StatusCode to 301, the Location to URI, and calling SendResponse.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.SendStream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the abstract (pure virtual) prototype of a method that sends the HTTP response message with the contents set to the contents of AStream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Only call <method namespace="HTTPApp" class="TWebResponse">SendStream</method> after first calling SendResponse. Unlike <method namespace="HTTPApp" class="TWebResponse">SendStream</method>, SendResponse fills the header of the HTTP response message, based on the properties of the <method namespace="HTTPApp" class="TWebResponse">TWebResponse</method> object. If SendResponse has not been called first to set the header of the HTTP response message, set the ContentStream property to AStream, and call SendResponse. </para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.SetCookieField">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds a cookie header to the response message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebResponse">SetCookieField</method> to add a cookie header to the Cookies property. Each cookie header contains a set of name/value pairs that can be passed on by the client application. Use the Values parameter to specify the name/value pairs as strings of the form Name=Value. Use the ADomain and APath parameters to indicate which URLs the cookie should be sent to. Use the AExpires parameter to indicate when the cookie is no longer valid. Use the ASecure property to indicate whether the cookie should only be passed on by the client if a secure connection is used.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">See the documentation on the Netscape Web site for more information about cookies.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.SetCustomHeader">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Replaces the value of a specified custom header.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebResponse">SetCustomHeader</method> to add a new custom header to the list maintained by the CustomHeaders property, or to change the value of one of the headers already in the list. <method namespace="HTTPApp" class="TWebResponse">SetCustomHeader</method> locates the header in the list with the name specified by the Name parameter. If a header with that name is in the list, <method namespace="HTTPApp" class="TWebResponse">SetCustomHeader</method> replaces the value of that header with the value specified as the Value parameter. If the name was not found, <method namespace="HTTPApp" class="TWebResponse">SetCustomHeader</method> adds a new header to the list with the given name and value.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Cookies">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists all cookie headers that should be sent with the response.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebResponse">Cookies</property> to obtain direct access to the individual TCookie objects that represent the fields of the cookie headers in the response message. Each TCookie object represents in individual cookie header that is included with the response message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the Add method of the cookie collection to add a single cookie to the collection, or use the SetCookieField method to add multiple related cookie headers to this collection. SetCookieField creates and adds new cookies that share a common set of values for the domain, path, expires, and secure fields. Use the HeaderValue property of the individual entries in <property namespace="HTTPApp" class="TWebResponse">Cookies</property> to determine the actual response header string that is sent for each cookie header.</para>
<para>For more information about the use of cookies, see the documentation on Netscape's Web site.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.HTTPRequest">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the HTTP request message for which this is a response.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebResponse">HTTPRequest</property> to determine the header and contents of the HTTP request message that spawned this response message. The properties of <property namespace="HTTPApp" class="TWebResponse">HTTPRequest</property> give access to the information sent in the web client request message.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Version">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the HTTP protocol version number that the web client is using.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebResponse">Version</property> to ensure that the properties set in the <property namespace="HTTPApp" class="TWebResponse">TWebResponse</property> object will be understood by the Web client. The value of <property namespace="HTTPApp" class="TWebResponse">Version</property> is taken from the Protocol<property namespace="HTTPApp" class="TWebResponse">Version</property> property of the TWebRequest object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information on the different HTTP protocol versions, see the Internet standards documentation.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ReasonString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the status of the response to the web client request as a human-readable string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">ReasonString</property> to inform the human web client of the success or failure of the HTTP request message. Each reason string is associated with a 3-digit status code whose value indicates the status of the response. The HTTP standard defines a number of stock status codes and corresponding reason strings. In addition, server applications can define new reason strings and associate them with unused status codes.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Server">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides information about the software used by the server application to handle the request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">Server</property> to a string giving the name and version number of the application that provides the Content of the response message. The value of <property namespace="HTTPApp" class="TWebResponse">Server</property> can contain multiple product identifiers and comments, listed in order of significance and separated by spaces. Product identifiers take the form ProductName/VersionNumber.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.WWWAuthenticate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists of one or more comma-separated challenges provided when the request fails with StatusCode 401 (Unauthorized).</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">WWWAuthenticate</property> when the HTTP request fails because it requires access to a URI in a realm for which the Web client has not provided a password. <property namespace="HTTPApp" class="TWebResponse">WWWAuthenticate</property> consists of an authentication scheme name, followed by a comma-separated list of parameter/value pairs that specify the parameters to the authentication scheme. The first parameter/value pair indicates the realm.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information about HTTP authentication schemes, see the Internet standards documents.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Realm">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the set of protected-access URIs that includes the URL specified by the HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">Realm</property> when the response message returns 401 (Unauthorized) or 402 (Payment required). <property namespace="HTTPApp" class="TWebResponse">Realm</property> is the name of a set of URIs that require a password or payment before the web client can access them. All the URIs in the realm, including the URL specified in the request message, are made available as soon as the Web client provides the password or payment for the realm. The server application should keep track, internally, of the passwords or payments the client has provided, using the client information provided by the TWebRequest object.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Allow">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the HTTP request methods that the application can service.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebResponse">Allow</property> to indicate what type of request methods the server application can respond to for the URI specified by HTTPRequest. <property namespace="HTTPApp" class="TWebResponse">Allow</property> is a string of method names, separated by commas. The method names can include any pre-defined methods from the HTTP standard, or any additional methods implemented by the server application. At a minimum, the <property namespace="HTTPApp" class="TWebResponse">TWebResponse</property> object must allow GET and HEAD requests.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Location">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the URI of a resource the web client should point to for the completion of its request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">Location</property> when the <property namespace="HTTPApp" class="TWebResponse">TWebResponse</property> created a new resource in response to the HTTP request message, or when servicing of the request must be delegated to another URI than the one specified in the HTTP request message.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentEncoding">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the mechanisms, if any, that are used to encode the content of the HTTP response message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">ContentEncoding</property> when the value of Content has been encoded before it is sent to the web client. The encoding mechanisms are listed in the order in which they are applied, separated by commas. Typically, <property namespace="HTTPApp" class="TWebResponse">ContentEncoding</property> indicates a compression method or an encoding method used to transfer extended-ASCII characters over the net.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the media type of the Content of the HTTP response message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">ContentType</property> to indicate the media type of the Content of the HTTP response message. The value of <property namespace="HTTPApp" class="TWebResponse">ContentType</property> must specify a valid MIME content type. The <property namespace="HTTPApp" class="TWebResponse">ContentType</property> string has the form Type/SubType.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, if the HTTP response message sends a string of HTML commands to the web client in response to a GET request, the <property namespace="HTTPApp" class="TWebResponse">ContentType</property> is text/html.</para>
<para>If the HTTP request message includes an Accept header, <property namespace="HTTPApp" class="TWebResponse">ContentType</property> should be one of the content types listed in the Accept property of TWebRequest.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentVersion">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the version associated with the Content of the HTTP response message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebResponse">ContentVersion</property> to specify a version associated with the Content of the HTTP response. The meaning of <property namespace="HTTPApp" class="TWebResponse">ContentVersion</property> depends on the type of information that is sent in the HTTP response. For example, if the Content of the HTTP response has a ContentType of text/html, <property namespace="HTTPApp" class="TWebResponse">ContentVersion</property> would be the version of HTML used. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Server applications that introduce meanings for the <property namespace="HTTPApp" class="TWebResponse">ContentVersion</property> property should document the interpretation they assign to <property namespace="HTTPApp" class="TWebResponse">ContentVersion</property>.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.DerivedFrom">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the URI of the resource where the Content of the HTTP response originated.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">DerivedFrom</property> to the URI where the value of Content originates. It is especially important to set <property namespace="HTTPApp" class="TWebResponse">DerivedFrom</property> when the Content of the HTTP response did not originate from the resource indicated by the URL property of the request object.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Title">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies a title for the Content of the HTTP response message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set the <property namespace="HTTPApp" class="TWebResponse">Title</property> property to add a <property namespace="HTTPApp" class="TWebResponse">Title</property> header to the HTTP response message. <property namespace="HTTPApp" class="TWebResponse">Title</property> is an optional application-specific title associated with the information included in the message.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.StatusCode">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the status of the response to the HTTP request message as a 3-digit integer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">StatusCode</property> to inform the web client the status of the HTTP request message. Status codes are standard return values that can be interpreted by all web clients. Each status code has a corresponding reason string that provides a human web client with a more understandable indication of the status.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The following tables lists the standard status codes and their corresponding reason strings.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Status codes not in the table can be created by the server application. When creating a new status code, the most significant digit should indicate the class of response, as follows:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2xx: Success (Request received, understood, and accepted)</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3xx: Redirection (Further action needed to complete the request)</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">4xx: Client Error (Request contains bad syntax or cannot be serviced)</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">5xx: Server Error (Server failed to handle a valid request)</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentLength">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the length, in bytes, of the Content property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">ContentLength</property> to the length of the Content property, if it is known. If the length of the Content property is unknown, or if the response message does not include any content, set <property namespace="HTTPApp" class="TWebResponse">ContentLength</property> to 0. Web clients use the <property namespace="HTTPApp" class="TWebResponse">ContentLength</property> when reading the contents of the HTTP response message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the contents of the response message are taken from a stream, the value of <property namespace="HTTPApp" class="TWebResponse">ContentLength</property> is set from the stream.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Date">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the time and date when the HTTP response message is sent to the web client.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">Date</property> to the current date and time immediately before sending the HTTP response message to the web client. The Web client uses <property namespace="HTTPApp" class="TWebResponse">Date</property> to determine the age of the information returned.</para>
<property namespace="HTTPApp" class="TWebResponse">Date</property> is represented using the T<property namespace="HTTPApp" class="TWebResponse">Date</property>Time type. The integral part of a T<property namespace="HTTPApp" class="TWebResponse">Date</property>Time value is the number of days that have passed since December 30, 1899. The fractional part of a T<property namespace="HTTPApp" class="TWebResponse">Date</property>Time value is the fraction of a 24-hour day that has elapsed.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Expires">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the date and time after which the Content of the HTTP response message should be considered invalid.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">Expires</property> when the Content of the HTTP response message contains information that may become invalid with the passage of time. Setting an <property namespace="HTTPApp" class="TWebResponse">Expires</property> value does not imply that the information or its source will necessarily change or cease to exist when the <property namespace="HTTPApp" class="TWebResponse">Expires</property> date and time is reached. Web clients are simply warned to check the freshness of the information after the <property namespace="HTTPApp" class="TWebResponse">Expires</property> date and time.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="HTTPApp" class="TWebResponse">Expires</property> is specified in Greenwich Mean Time.</para>
<property namespace="HTTPApp" class="TWebResponse">Expires</property> is represented using the TDateTime type. The integral part of a TDateTime value is the number of days that have passed since December 30, 1899. The fractional part of a TDateTime value is the fraction of a 24-hour day that has elapsed.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.LastModified">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the date and time that the value of the Content property was last updated.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">LastModified</property> to indicate the last time the Content of the response was modified. This allows web clients to determine whether their local version of that information is up-to-date. When the HTTP request is a HEAD message, this may allow the web client and server to skip a potentially expensive transfer of information.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="HTTPApp" class="TWebResponse">LastModified</property> is specified in the local time of the machine. The HTTP response message translates this value to the date encoding used by HTTP.</para>
<property namespace="HTTPApp" class="TWebResponse">LastModified</property> is represented using the TDateTime type. The integral part of a TDateTime value is the number of days that have passed since December 30, 1899. The fractional part of a TDateTime value is the fraction of a 24-hour day that has elapsed.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Content">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Contains the information sent to the web client in response to an HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebResponse">Content</property> to send requested information to the web client. Not every HTTP request message requires content to be returned. For example, responses to requests with a Method of OPTIONS, HEAD, POST, PUT, DELETE, or TRACE should not include any <property namespace="HTTPApp" class="TWebResponse">Content</property>. In all these cases, the response information is contained entirely in the response header, which is built from the other properties of the <property namespace="HTTPApp" class="TWebResponse">TWebResponse</property> object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The response content can be a string of HTML commands, the name of an HTML file, graphic content such as a bit-stream, or any other MIME content type.</para>
<para>If the <property namespace="HTTPApp" class="TWebResponse">Content</property>Stream property is set, it supersedes the value of the <property namespace="HTTPApp" class="TWebResponse">Content</property> property. If both <property namespace="HTTPApp" class="TWebResponse">Content</property> and <property namespace="HTTPApp" class="TWebResponse">Content</property>Stream are set, the web client is sent the value of the <property namespace="HTTPApp" class="TWebResponse">Content</property>Stream, not the value of the <property namespace="HTTPApp" class="TWebResponse">Content</property> property.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ContentStream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the stream object for writing the contents of the HTTP response message to the web client.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebResponse">ContentStream</property> to set the contents of the HTTP response message to a value that can be written from a stream. <property namespace="HTTPApp" class="TWebResponse">ContentStream</property> allows the response object to write its contents directly from a stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The stream specified by <property namespace="HTTPApp" class="TWebResponse">ContentStream</property> can access a string of HTML commands, the contents of a BLOB database field, or any MIME content type.</para>
<property namespace="HTTPApp" class="TWebResponse">ContentStream</property> supersedes the Content property. If both Content and <property namespace="HTTPApp" class="TWebResponse">ContentStream</property> are set, the web client is sent the value of the <property namespace="HTTPApp" class="TWebResponse">ContentStream</property>, not the value of the Content property.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.LogMessage">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes the HTTP response message for event logging purposes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebResponse">LogMessage</property> to a description of the action carried out by the TWebActionItem object that services this HTTP response. Usually, <property namespace="HTTPApp" class="TWebResponse">LogMessage</property> includes the URI that handled the request message, along with date and time information.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.CustomHeaders">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists message header strings that are added to the response message before it is sent.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebResponse">CustomHeaders</property> to add header information to the response that can not be specified using the other properties of <property namespace="HTTPApp" class="TWebResponse">TWebResponse</property>. Each string in the <property namespace="HTTPApp" class="TWebResponse">CustomHeaders</property> property has the form HeaderName=Value, where HeaderName specifies the name of the header, and Value is the value for that header, formatted as a string.</para>
<para>Setting the <property namespace="HTTPApp" class="TWebResponse">CustomHeaders</property> property assigns a set of strings to the custom headers list. It does not replace the TStrings object that is the value of <property namespace="HTTPApp" class="TWebResponse">CustomHeaders</property>.</para>
<property namespace="HTTPApp" class="TWebResponse">CustomHeaders</property> includes at most one value for each HeaderName. If the HTTP message includes multiple headers with the same name, only the first header's value will appear in <property namespace="HTTPApp" class="TWebResponse">CustomHeaders</property>.</para>
<class namespace="HTTPApp">TAbstractWebSession</class> is the base class for all Web session objects. These include active sessions, which are represented by TWebSession objects, and invalid sessions (TInvalidWebSession), which are used to represent sessions that can no longer be used because they have expired.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A Web session has an ID and a list of name/value pairs. The ID is a random number that uniquely identifies the session. The name/value pairs are used to associate information with the ID. The values are variants. You can use these named Variants to store application-defined information that is associated with a single user. In this way, the information can persist over multiple calls from the same user.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The session ID is stored on the end user's computer using a cookie. When a request is received, the WebSnap application examines the cookie. If a session associated with this cookie exists, then it becomes the current session.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">There is no need to instantiate session objects. A Session is created automatically when the WebSnap application receives an HTTP request message. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the current session is terminated, its session ID and name/value pairs are discarded. For example, the current session is typically terminated when the user logs out. Sessions can also be terminated when they are not accessed within a specified time-out period, or when the application explicitly calls the session's Terminate method. A new session is created after a session has been terminated.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.UpdateResponse">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds the session ID to a cookie in a response message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TAbstractWebSession">UpdateResponse</method> to add the value of the SessionID property to one of the response message's cookies. This allows the user's next request message to use the Values stored in this session. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AResponse is the Web response message to which a cookie with the session ID should be added. </para>
<method namespace="HTTPApp" class="TAbstractWebSession">Terminate</method>s the session.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TAbstractWebSession">Terminate</method> to explicitly terminate a session. Once a session terminates, the application can no longer access its Values.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sessions are terminated automatically when the application does not receive any requests for the session for TimoutMinutes minutes. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TAbstractWebSession">TAbstractWebSession</method>, <method namespace="HTTPApp" class="TAbstractWebSession">Terminate</method> is abstract or, in C++ terminology, pure virtual, meaning it has no implementation. Descendant classes must override this method to provide an implementation.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.TimeoutMinutes">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the time, in minutes, that a session can be idle before it terminates itself.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TAbstractWebSession">TimeoutMinutes</property> to specify the number of minutes that can elapse before a session times out. If this number of minutes elapses with no request messages that call for the session, the session is terminated.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If you do not specify a value for <property namespace="HTTPApp" class="TAbstractWebSession">TimeoutMinutes</property>, the session times out after the default time-out period associated with the application's sessions service (TSessionsService).</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Values">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the named values that the session stores.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TAbstractWebSession">Values</property> to get or set the information that the session stores. Because sessions are associated with individual users, this information typically represents information about the user or choices the user makes. The <property namespace="HTTPApp" class="TAbstractWebSession">Values</property> property can be used to implement application-specific tasks, such as saving user preferences or maintaining a list user selections.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each value is indexed by a name that indicates its meaning. The names can be any application-defined string.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.SessionID">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Uniquely identifies the Session.</para>
<property namespace="HTTPApp" class="TAbstractWebSession">SessionID</property> is an automatically-generated identifier that uniquely identifies the session. The UpdateResponse method adds this identifier to response messages, using a cookie. When the WebSnap application receives a request containing a cookie with a session ID, the WebSnap application uses the ID to recreate a copy of the previous session object.</para>
<class namespace="HTTPApp">IProduceContent</class> is the interface for generating the content of a Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Content producers (such as TAdapaterPageProducer) implement the <class namespace="HTTPApp">IProduceContent</class> interface. This interface defines a single method, ProduceContent, which returns the content to assign to an HTTP response message in a WebSnap application.</para>
<para>In C++, method declarations that use <class namespace="HTTPApp">IProduceContent</class> use the _di_<class namespace="HTTPApp">IProduceContent</class> type instead. This type is a DelphiInterface wrapper around the <class namespace="HTTPApp">IProduceContent</class> interface:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the content that the producer creates.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="IProduceContent">ProduceContent</method> to retrieve the content for using in an HTTP response message. In most cases, this content is a string of HTML commands defining a Web page, although it can be any valid MIME type.</para>
<class namespace="HTTPApp">IWebAppServices</class> is the interface for setting up and finishing the processing of HTTP request messages.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WebSnap applications use the <class namespace="HTTPApp">IWebAppServices</class> interface to drive the processing of incoming request messages. When the WebSnap application receives an HTTP request message it</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1. Calls InitContext to set up a Web context for the request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2. Calls HandleRequest to forward the request to the components that process it.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3. Calls FinishContext to shut down the Web context in an orderly fashion.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In addition to providing access to these core methods of the application, <class namespace="HTTPApp">IWebAppServices</class> introduces the ExceptionHandler property. The ExceptionHandler property allows the application access to the component that handles any exceptions that escape all of the try blocks in the application while processing the message.</para>
<para>Method declarations that use <class namespace="HTTPApp">IWebAppServices</class> use the _di_<class namespace="HTTPApp">IWebAppServices</class> type instead. This type is a DelphiInterface wrapper around the <class namespace="HTTPApp">IWebAppServices</class> interface:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Directs the processing of the current request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the WebSnap application receives a request message, it makes the following calls:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1. The InitContext method is called to generate a Web context for the request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2. <method namespace="HTTPApp" class="IWebAppServices">HandleRequest</method> is called to generate a response to the request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3. FinishContext is called to perform any final cleanup.</para>
<method namespace="HTTPApp" class="IWebAppServices">HandleRequest</method> locates the dispatcher components that handle the request and forwards the request to a dispatcher for processing.</para>
<method namespace="HTTPApp" class="IWebAppServices">HandleRequest</method> returns true if the request is handled and the response should be sent back to the caller (if it was not already sent). It returns false if the WebSnap application could not handle the request.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.InitContext">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates and initializes the Web context for the current Web request.</para>
<method namespace="HTTPApp" class="IWebAppServices">InitContext</method> is called when the WebSnap application first receives a request message to set up the Web context before the application attempts to handle the request. It creates and sets up the global Web context, which can be accessed by calling the global WebContext function. It also performs any other initializations that ready the application for handling a new request message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WebModuleList lists the currently active Web modules in the WebSnap application and provides access to all Web module factories so that the application can create any new modules it needs for processing the request message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Request describes the new request message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Response is the response object that the WebSnap application should fill out when handling the current request.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.FinishContext">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Performs any final tasks after the WebSnap application has finished processing a request.</para>
<method namespace="HTTPApp" class="IWebAppServices">FinishContext</method> is called as the last step before a WebSnap application sends a response message back to the caller. <method namespace="HTTPApp" class="IWebAppServices">FinishContext</method> performs any final tasks, and frees all the objects and components that were created to handle the request message (including the Web context).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the object that handles exceptions that arise when processing a request message.</para>
<property namespace="HTTPApp" class="IWebAppServices">ExceptionHandler</property> is the object that the WebSnap application calls when an exception is raised while trying to process a request message. The request handler must implement the IWeb<property namespace="HTTPApp" class="IWebAppServices">ExceptionHandler</property> interface, which includes only a single method: HandleException.</para>
<class namespace="HTTPApp">IWebRequestHandler</class> is the interface for objects that dispatch HTTP request messages.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Dispatcher components such as TPageDispatcher , TAdapterDispatcher, and TWebDispatcher implement the <class namespace="HTTPApp">IWebRequestHandler</class> interface. This interface includes only a single method, HandleRequest, which processes an HTTP request message, filling out the corresponding response, which can then be returned to the caller.</para>
<para>In C++, method declarations that use <class namespace="HTTPApp">IWebRequestHandler</class> use the _di_<class namespace="HTTPApp">IWebRequestHandler</class> type instead. This type is a DelphiInterface wrapper around the <class namespace="HTTPApp">IWebRequestHandler</class> interface:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Processes an HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="IWebRequestHandler">HandleRequest</method> to process an HTTP request message and obtain the response that should be sent back to the caller.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Request is the request object that describes the request to process.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Response is the response object that should be filled out when the request is processed.</para>
<class namespace="HTTPApp">IWebDispatchActions</class> is the interface for components that dispatch HTTP request messages using action items.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Web dispatcher components (TWebDispatcher and TWebModule) implement the <class namespace="HTTPApp">IWebDispatchActions</class> interface. This interface serves primarily to identify components that use action items to handle HTTP request messages.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To obtain an <class namespace="HTTPApp">IWebDispatchActions</class> interface, use the DispatchActions property of a TWebAppComponents object.</para>
<para>In C++, method declarations that use <class namespace="HTTPApp">IWebDispatchActions</class> use the _di_<class namespace="HTTPApp">IWebDispatchActions</class> type instead. This type is a DelphiInterface wrapper around the <class namespace="HTTPApp">IWebDispatchActions</class> interface:</para>
<class namespace="HTTPApp">IWebDispatcherAccess</class> provides access to the current HTTP request and response object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <class namespace="HTTPApp">IWebDispatcherAccess</class> interface declares two methods, Request and Response. These return the objects that represent the current HTTP request message that is being processed and the emerging HTTP response message that will be sent back to the caller.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In Web Broker applications, a TWebDispatcher or TWebModule component implements this interface. <condition os="Windows">In WebSnap applications, a TWebAppComponents component implements this interface.</condition>
<para>In C++, method declarations that use <class namespace="HTTPApp">IWebDispatcherAccess</class> use the _di_<class namespace="HTTPApp">IWebDispatcherAccess</class> type instead. This type is a DelphiInterface wrapper around the <class namespace="HTTPApp">IWebDispatcherAccess</class> interface:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the Web request object for the HTTP request message to which the application is responding.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="IWebDispatcherAccess">Request</method> to obtain access to the current Web request object. The request object provides access to the headers of the request message, as well as the content of the message.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Response">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the Web response object for the HTTP response message that the application is assembling.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="IWebDispatcherAccess">Response</method> to obtain access to the current Web response object. The response object provides access to the headers of the response message, as well as the content of the message.</para>
<class namespace="HTTPApp">TCustomContentProducer</class> is the base class for all objects that produce the string that is sent as the contents of an HTTP response message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPApp">TCustomContentProducer</class> as a base class when defining a class to produce the contents of an HTTP response message. In most cases, the content producer will assemble a string of HTML commands. However, descendants of <class namespace="HTTPApp">TCustomContentProducer</class> can be defined to produce any valid MIME type.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Content">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the content produced by the content producer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TCustomContentProducer">Content</method> to retrieve the content for using in an HTTP response message. TCustom<method namespace="HTTPApp" class="TCustomContentProducer">Content</method>Producer returns an empty string. Descendants of TCustom<method namespace="HTTPApp" class="TCustomContentProducer">Content</method>Producer return the value of the content that they produce. In most cases, this content is a string of HTML commands, although it can be any valid MIME type.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the content produced in response to input read from a stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TCustomContentProducer">ContentFromStream</method> to retrieve the content produced by the content producer based on the information provided by the Stream parameter. <method namespace="HTTPApp" class="TCustomContentProducer">TCustomContentProducer</method> ignores the Stream parameter and returns the value created by the Content method. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="HTTPApp" class="TCustomContentProducer">TCustomContentProducer</method> override this method to interpret streamed input in their own way.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the content produced in response to an input string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TCustomContentProducer">ContentFromString</method> to retrieve the content produced by the content producer based on the information provided by the S parameter. <method namespace="HTTPApp" class="TCustomContentProducer">TCustomContentProducer</method> ignores the string and returns the value created by the Content method. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="HTTPApp" class="TCustomContentProducer">TCustomContentProducer</method> override this method to interpret the input string in their own way.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Notification">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Overrides the inherited method to respond to messages that the dispatcher is going away.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited method, <method namespace="HTTPApp" class="TCustomContentProducer">Notification</method> checks whether this call was triggered by the removal of the dispatcher. If so, the Dispatcher property is set to <condition language="Delphi">nil.</condition>
<condition language="CBuilder">NULL.</condition>
</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Dispatcher">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the dispatcher for the Web server application that includes the <property namespace="HTTPApp" class="TCustomContentProducer">TCustomContentProducer</property> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TCustomContentProducer">Dispatcher</property> to access the interface of the dispatcher. In Web Broker applications, this is the interface of a TWeb<property namespace="HTTPApp" class="TCustomContentProducer">Dispatcher</property> or TWebModule component. In WebSnap applications, this is the interface of a TWebAppComponents component. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The IWeb<property namespace="HTTPApp" class="TCustomContentProducer">Dispatcher</property>Access interface has two methods:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Request, which returns the HTTP request message to which this component responds.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Response, which returns the HTTP response message for which this component generates content.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the dispatcher component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Dispatcher component is the component that implements the interface that is the value of the Dispatcher property. The content producer uses this property so that it can respond to notifications when the component is freed. To use the dispatcher, use the Dispatcher property instead.</para>
<class namespace="HTTPApp">TWebActionItem</class> allows a Web server application to create and send responses to HTTP request messages.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPApp">TWebActionItem</class> to assemble the response to a particular type of HTTP request message in a Web server application. Each action item is specific to a particular URI path and HTTP request method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The web dispatcher chooses an appropriate action item to handle an HTTP request message by </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">matching the path portion of the URI requested by the Web client with the PathInfo property in the <class namespace="HTTPApp">TWebActionItem</class> object</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">matching the method requested by the Web client with the method type the action item knows how to handle.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An action item handles an HTTP request message automatically using an associated content producer or using its OnAction event handler. The OnAction event handler can read the request message and assemble a response by setting the properties of a TWebResponse object. It can tell the TWebResponse object to send the response message back to the Web client, or allow the TWebApplication object to send the message after other action items have had a chance to add to the response.</para>
<method namespace="HTTPApp" class="TWebActionItem">Create</method>s an instance of <method namespace="HTTPApp" class="TWebActionItem">TWebActionItem</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebActionItem">Create</method> to create a <method namespace="HTTPApp" class="TWebActionItem">TWebActionItem</method> object at runtime. Action items created in the action editor at design time are instantiated automatically.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited constructor, <method namespace="HTTPApp" class="TWebActionItem">Create</method> initializes the Enabled property to True, and sets the action item so that it will match any HTTP request targeted to a URI with an empty PathInfo.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.AssignTo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the properties of the action item to another action item.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To assign the value of one action item to another, use the Assign method of the target action item.</para>
<method namespace="HTTPApp" class="TWebActionItem">AssignTo</method> enables the Assign method of a target action item to copy the properties of a source action item. <method namespace="HTTPApp" class="TWebActionItem">AssignTo</method> copies the values of the Default, Enabled, MethodType and PathInfo properties to the Dest parameter if it is an action item. If Dest is not an action item, <method namespace="HTTPApp" class="TWebActionItem">AssignTo</method> calls the inherited method.</para>
<method namespace="HTTPApp" class="TWebActionItem">Destroy</method>s an instance of <method namespace="HTTPApp" class="TWebActionItem">TWebActionItem</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="HTTPApp" class="TWebActionItem">Destroy</method> directly in an application. Action items are destroyed when the <method namespace="HTTPApp" class="TWebActionItem">TWebActionItem</method>s object that manages them calls the Free method.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Default">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the action item should handle any request that is not handled by another available action item.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebActionItem">Default</property> to true to make this action item the default action in the list of action items maintained by the TWebDispatcher object. TWebDispatcher attempts to match HTTP request messages to action items by matching the MethodType and PathInfo of the target URI. If no match can be found, the TWebDispatcher invokes the default action item, regardless of its MethodType or PathInfo properties.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When an action item is chosen as the default action item, the value of its Enabled property is ignored. Thus, if an action item sets Enabled to false and <property namespace="HTTPApp" class="TWebActionItem">Default</property> to true, TWebDispatcher will first look for a match with any other action item, even if the PathInfo and MethodType of the default action item match the request perfectly. Then, only after all other action items have been rejected, TWebDispatcher selects the default action item. If the default action item is enabled, it may be selected before all other action items have been considered because the MethodType and PathInfo match the request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The default action item must be prepared to generate a response to any HTTP request, for any MethodType and PathInfo. This may consist of simply setting a response status code of 404 (the URI could not be matched) or 405 (the requested method is not supported).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Setting <property namespace="HTTPApp" class="TWebActionItem">Default</property> to true sets the <property namespace="HTTPApp" class="TWebActionItem">Default</property> property of the previous default action item to false.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Enabled">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the action item can respond to HTTP request messages that match its MethodType and PathInfo properties.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebActionItem">Enabled</property> to false to disable an action item. TWebDispatcher will ignore disabled action items when it looks for an action item to handle a request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When an action item is chosen as the default action item, the value of its <property namespace="HTTPApp" class="TWebActionItem">Enabled</property> property is ignored. Thus, if an action item sets <property namespace="HTTPApp" class="TWebActionItem">Enabled</property> to false and Default to true, TWebDispatcher will first look for a match with any other action item, even if the PathInfo and MethodType of the default action item match the request perfectly. Then, only after all other action items have been rejected, the TWebDispatcher selects the default action item. If the default action item is enabled, it may be selected before all other action items have been considered because the MethodType and PathInfo match the request.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Name">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies an individual action item when it is referenced from other objects.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebActionItem">Name</property> to uniquely specify an individual action item in code anywhere in the application. For action items, <property namespace="HTTPApp" class="TWebActionItem">Name</property> is equivalent to the Display<property namespace="HTTPApp" class="TWebActionItem">Name</property> property. Therefore, when setting the <property namespace="HTTPApp" class="TWebActionItem">Name</property> property, the new value must not match the Display<property namespace="HTTPApp" class="TWebActionItem">Name</property> of any other action item in the list maintained by TCustomWebDispatcher. Trying to set the <property namespace="HTTPApp" class="TWebActionItem">Name</property> to a Display<property namespace="HTTPApp" class="TWebActionItem">Name</property> that is already in use raises an exception.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.PathInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the path portion of the Uniform Resource Identifier (URI) for which the action item handles requests.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebActionItem">PathInfo</property> to the path portion of the URI for the target of any request messages serviced by the action item. TWebDispatcher matches action items to request messages by comparing <property namespace="HTTPApp" class="TWebActionItem">PathInfo</property> with the path portion of the URI specified as the target of the request. If the <property namespace="HTTPApp" class="TWebActionItem">PathInfo</property> properties match, and the MethodType matches, TWebDispatcher invokes the action item to respond to the request message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the action item has an associated content producer, the value of <property namespace="HTTPApp" class="TWebActionItem">PathInfo</property> is the name of the producer unless it is explicitly changed.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Producer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies a content producer that generates the content of response messages when the action item executes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="HTTPApp" class="TWebActionItem">Producer</property> to associate the action item with a content producer of the type TCustomContent<property namespace="HTTPApp" class="TWebActionItem">Producer</property>. (If a content producer of type IProduceContent is used instead of TCustomContent<property namespace="HTTPApp" class="TWebActionItem">Producer</property>, then the property <property namespace="HTTPApp" class="TWebActionItem">Producer</property>Content should be set instead.) If <property namespace="HTTPApp" class="TWebActionItem">Producer</property> is not nil (Delphi) or NULL (C++), then when the web dispatcher passes a request message to the action item, the action item sets the Content property of the response message to the value returned by the producer's Content method. After the content producer has assigned the response's Content property, the action item receives an OnAction event, where it can optionally set other response properties or send the response message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="HTTPApp" class="TWebActionItem">Producer</property> is nil (Delphi) or NULL (C++), the action item must use the OnAction event handler to influence the response message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The properties <property namespace="HTTPApp" class="TWebActionItem">Producer</property> and <property namespace="HTTPApp" class="TWebActionItem">Producer</property>Content are mutually exclusive. If one is set, the other must not be.</para>
<para>Each content producer can be associated with only one action item at a time. Setting the <property namespace="HTTPApp" class="TWebActionItem">Producer</property> property of one action item causes the Web dispatcher that manages that item to check whether any other action item has its <property namespace="HTTPApp" class="TWebActionItem">Producer</property> property set to the same component. If another action item was associated with the same producer, its <property namespace="HTTPApp" class="TWebActionItem">Producer</property> property is changed to nil (Delphi) or NULL (C++).</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ProducerContent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies a content producer that generates the content of response messages when the action item executes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">This property is identical to Producer except for the type of content producer. <property namespace="HTTPApp" class="TWebActionItem">ProducerContent</property> is used when the producer is of type IProduceContent instead of TCustomContentProducer. In the latter case, the property Producer is set instead. Note that Producer and <property namespace="HTTPApp" class="TWebActionItem">ProducerContent</property> are mutually exclusive; if one is set, the other must not be.</para>
</comments>
</member>
<member name="E:HTTPApp.HTTPApp.OnAction">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when TWebDispatcher matches the action item to a newly-arrived HTTP request message.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="HTTPApp" class="TWebActionItem">OnAction</event> event handler to respond to HTTP request messages that match the MethodType and PathInfo properties. <event namespace="HTTPApp" class="TWebActionItem">OnAction</event> occurs immediately after the response message's Content property has been initialized by the action item's Producer property (if Producer is set).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In an <event namespace="HTTPApp" class="TWebActionItem">OnAction</event> event handler, read Request and perform the requested Method if possible. Set the properties of the Response parameter as appropriate. If the <event namespace="HTTPApp" class="TWebActionItem">OnAction</event> event handler does not service the response, or if it only partially handles the request and must let another action item finish the response, set the Handled parameter to false. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An <event namespace="HTTPApp" class="TWebActionItem">OnAction</event> event handler can call the SendRedirect or SendResponse method of Response to send the HTTP response message to the Web client. If the <event namespace="HTTPApp" class="TWebActionItem">OnAction</event> event handler does not send the response, the Web application will send it after all action items have finished filling in the Response.</para>
<para>The <event namespace="HTTPApp" class="TWebActionItem">OnAction</event> event handler can use descendants of TCustomContentProducer to help assemble the contents of the response message.</para>
<class namespace="HTTPApp">TWebActionItems</class> is a collection of TWebActionItem objects.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TCustomWebDispatcher uses <class namespace="HTTPApp">TWebActionItems</class> to store and manipulate the individual action items it manages. <class namespace="HTTPApp">TWebActionItems</class> provides properties and events to</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Add new action items to the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copy the list of action items from another <class namespace="HTTPApp">TWebActionItems</class>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Get the attributes of specified action items in the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Empty the collection of action items.</para>
<method namespace="HTTPApp" class="TWebActionItems">Add</method>s a new action item to the end of the collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TWebActionItems">Add</method> to add an action item to the collection of action items managed by the dispatcher. The new item is added to the end of the Items array. <method namespace="HTTPApp" class="TWebActionItems">Add</method> returns the action item so that its properties can be set to specify its use.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Because the dispatcher looks through the action items in order when it tries to find an action item to handle an HTTP request message, add any action items that preprocess HTTP requests first. Then add the most specific action items. This way, more general action items will not be matched to request messages before a closer match can be found.</para>
<method namespace="HTTPApp" class="TWebActionItems">Create</method>s an instance of <method namespace="HTTPApp" class="TWebActionItems">TWebActionItems</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the constructor for <method namespace="HTTPApp" class="TWebActionItems">TWebActionItems</method>. <method namespace="HTTPApp" class="TWebActionItems">TWebActionItems</method> is tailored to work with TCustomWebDispatcher. The TCustomWebDispatcher object creates <method namespace="HTTPApp" class="TWebActionItems">TWebActionItems</method> in its own constructor.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.WebDispatcher">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the dispatcher that uses <property namespace="HTTPApp" class="TWebActionItems">TWebActionItems</property> to store and manipulate its action items.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TWebActionItems">WebDispatcher</property> to get access to the dispatcher object that uses the collection of action items to respond to HTTP request messages.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Items">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the TWebActionItem objects stored by this TWebAction<property namespace="HTTPApp" class="TWebActionItems">Items</property> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TWebActionItems">Items</property> to get access to the individual action items stored by the TWebAction<property namespace="HTTPApp" class="TWebActionItems">Items</property> object. <property namespace="HTTPApp" class="TWebActionItems">Items</property> is an indexed array, where the first action item has index 0, the second action item has index 1, and so on. Use <property namespace="HTTPApp" class="TWebActionItems">Items</property> with the Count property to iterate over all the action items in the collection.</para>
<class namespace="HTTPApp">TCustomWebDispatcher</class> is the abstract base class for Web dispatcher objects.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Add a descendant of <class namespace="HTTPApp">TCustomWebDispatcher</class> to a Web application to enable it to respond to HTTP request messages. When a Web application is created, it automatically includes a TWebModule object, which is a descendant of <class namespace="HTTPApp">TCustomWebDispatcher</class>. Keep the default Web module, or replace it with another data module that contains a descendant of <class namespace="HTTPApp">TCustomWebDispatcher</class>, such as TWebDispatcher.</para>
<class namespace="HTTPApp">TCustomWebDispatcher</class> manages the action items that assemble responses to HTTP request messages. When the TWebApplication object receives an HTTP request message, <class namespace="HTTPApp">TCustomWebDispatcher</class> passes the request on to the appropriate action item or action items to service the message.</para>
<class namespace="HTTPApp">TCustomWebDispatcher</class> also keeps track of information about the current HTTP message for the benefit of TCustomContentProducer objects.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.DoAfterDispatch">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an AfterDispatch event and returns a value that indicates whether the Web application can send the response.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications cannot call <method namespace="HTTPApp" class="TCustomWebDispatcher">DoAfterDispatch</method>. The DispatchAction method calls <method namespace="HTTPApp" class="TCustomWebDispatcher">DoAfterDispatch</method> after sending the HTTP request message to any matching action items. The DispatchAction method does not call <method namespace="HTTPApp" class="TCustomWebDispatcher">DoAfterDispatch</method> if the HTTP request message was not handled by the action items or by a BeforeDispatch event handler. <method namespace="HTTPApp" class="TCustomWebDispatcher">DoAfterDispatch</method> is also not called if the message was already sent back to the Web client. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the AfterDispatch event handler indicates that the response should not be sent, <method namespace="HTTPApp" class="TCustomWebDispatcher">DoAfterDispatch</method> returns false, and the Web application drops the connection without sending the response message. Otherwise, <method namespace="HTTPApp" class="TCustomWebDispatcher">DoAfterDispatch</method> returns true, and the Web application sends the response message if it was not sent from within the AfterDispatch event handler.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates a BeforeDispatch event and returns a value that indicates whether the dispatcher should look for action items to handle the request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications cannot call <method namespace="HTTPApp" class="TCustomWebDispatcher">DoBeforeDispatch</method>. The DispatchAction method calls <method namespace="HTTPApp" class="TCustomWebDispatcher">DoBeforeDispatch</method> before trying to match the HTTP request message with any of its action items. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the BeforeDispatch event handler indicates that it has handled the request message, <method namespace="HTTPApp" class="TCustomWebDispatcher">DoBeforeDispatch</method> returns true, and the DispatchAction method does not try to pass the request message to any of the action items. Otherwise, <method namespace="HTTPApp" class="TCustomWebDispatcher">DoBeforeDispatch</method> returns false, and unless the response message was sent from within the BeforeDispatch event handler, the DispatchAction method proceeds with looking for action items to handle the request message.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <method namespace="HTTPApp" class="TCustomWebDispatcher">DoBeforeDispatch</method> returns true but the response has not been sent, DispatchAction generates an AfterDispatch event.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.DispatchAction">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Passes an HTTP request message to the action items in Actions until it is handled.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Web application calls <method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> when it receives an HTTP request message so that the dispatcher can dispatch the request to any action items that can generate the response.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Before <method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> looks for action items to handle the HTTP request message represented by the Request parameter, it generates a BeforeDispatch event. If the BeforeDispatch event handler handles the action, the dispatcher does not pass the request message to any of the action items.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If there is no BeforeDispatch event handler, or of the BeforeDispatch event handler does not handle the request, <method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> attempts to match the MethodType and PathInfo of the request with the MethodType and PathInfo properties of each action item in the Actions property. When an action item matches the MethodType and PathInfo of the request, <method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> calls its OnAction event handler.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The OnAction event handler can complete the response to the request, or indicate that the request is not fully handled and allow another action item to finish processing the request. If the OnAction event handler does not complete the request, <method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> continues checking the action items in the Actions property and calling the OnAction event handler when a match is found.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If all of the action items are checked, and the request is still not fully handled, <method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> calls the OnAction event handler of the default action item.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Finally, if the request has been handled by the BeforeDispatch event handler or any of the action items, <method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> generates an AfterDispatch event. The AfterDispatch event does not occur if the BeforeDispatch event or any of the action items has already sent the response.</para>
<method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> returns a Boolean value indicating whether the Web application should send the response message if it is not already sent. <method namespace="HTTPApp" class="TCustomWebDispatcher">DispatchAction</method> returns true if the action was handled by the action items and the AfterDispatch event handler did not change its Handled parameter to false.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.ActionByName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the action item identified by the AName parameter.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TCustomWebDispatcher">ActionByName</method> to gain access to an individual action item when its name is known. Change the properties of the action item so that it handles different HTTP request messages, or invoke its OnAction event handler to respond to an HTTP request message.</para>
<method namespace="HTTPApp" class="TCustomWebDispatcher">Create</method>s an instance of <method namespace="HTTPApp" class="TCustomWebDispatcher">TCustomWebDispatcher</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the constructor for <method namespace="HTTPApp" class="TCustomWebDispatcher">TCustomWebDispatcher</method>. Web applications automatically include a Web module. If the Web module is replaced by another data model, the Web dispatcher should be added to the new data module at design time. Objects placed at design time are created automatically. If an application tries to create a dispatcher object in a Web module, or in a data module that already has a Web dispatcher, an exception is raised.</para>
<method namespace="HTTPApp" class="TCustomWebDispatcher">Create</method> creates the TWebActionItems object that holds the action items managed by the dispatcher. If the Web dispatcher is included in another data module, it adds a reference to itself to any content producer in that data module.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After the Web dispatcher is created automatically at runtime, an On<method namespace="HTTPApp" class="TCustomWebDispatcher">Create</method> event occurs.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.HandleException">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides default handling of exceptions for the web application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If an exception passes through all the try blocks in the web application code, the application automatically calls <method namespace="HTTPApp" class="TCustomWebDispatcher">HandleException</method>, which displays a dialog box indicating an error occurred. Unless the exception object is EAbort, <method namespace="HTTPApp" class="TCustomWebDispatcher">HandleException</method> calls the OnException event handler.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To assign other exception handling code for the web application, use the OnException event handler.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Notification">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds to notifications when objects are added to the module.</para>
<method namespace="HTTPApp" class="TCustomWebDispatcher">Notification</method> ensures that all TCustomContentProducer objects have access to the dispatcher, by setting their Dispatcher property as they are added to the application.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.Destroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Frees an instance of <method namespace="HTTPApp" class="TCustomWebDispatcher">TCustomWebDispatcher</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not destroy the <method namespace="HTTPApp" class="TCustomWebDispatcher">TCustomWebDispatcher</method> directly in an application. The dispatcher is freed automatically when the server application shuts down.</para>
<method namespace="HTTPApp" class="TCustomWebDispatcher">Destroy</method> frees the TWebActionItems object used to hold the collection of action items.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Actions">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the collection of action items managed by the <property namespace="HTTPApp" class="TCustomWebDispatcher">TCustomWebDispatcher</property> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the methods of <property namespace="HTTPApp" class="TCustomWebDispatcher">Actions</property> to add action items for use by the dispatcher, to clear the set of action items managed by the dispatcher, or to access the attributes of the action items.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Action">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides indexed access to the action items managed by the <property namespace="HTTPApp" class="TCustomWebDispatcher">TCustomWebDispatcher</property> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TCustomWebDispatcher">Action</property> to iterate over all of the actions in the <property namespace="HTTPApp" class="TCustomWebDispatcher">Action</property>s collection. Zero is the index of the first action item, one is the index of the second action item, and so on. To access individual actions by name, use the <property namespace="HTTPApp" class="TCustomWebDispatcher">Action</property>ByName method.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Request">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the TWeb<property namespace="HTTPApp" class="TCustomWebDispatcher">Request</property> object that the dispatcher is currently handling.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TCustomWebDispatcher">Request</property> to obtain information about the current HTTP request message. The dispatcher matches this TWeb<property namespace="HTTPApp" class="TCustomWebDispatcher">Request</property> object to an action item, and invokes the OnAction event handler of the action item to generate and send a response to the HTTP request message. OnAction event handlers often use descendants of TCustomContentProducer to help generate the response to the request message. These content producers can use the <property namespace="HTTPApp" class="TCustomWebDispatcher">Request</property> property to correctly produce the content of the HTTP response.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Response">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the TWeb<property namespace="HTTPApp" class="TCustomWebDispatcher">Response</property> object for the message the dispatcher is currently handling.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="HTTPApp" class="TCustomWebDispatcher">Response</property> to obtain information about the emerging response to the current HTTP request message. The dispatcher matches the request object specified by the Request property to an action item. It then invokes the OnAction event handler of the action item to fill in the TWeb<property namespace="HTTPApp" class="TCustomWebDispatcher">Response</property> object specified by the <property namespace="HTTPApp" class="TCustomWebDispatcher">Response</property> property. OnAction event handlers often use descendants of TCustomContentProducer to help generate the response. These content producers can use <property namespace="HTTPApp" class="TCustomWebDispatcher">Response</property> to determine the state of the emerging response that is being produced.</para>
</comments>
</member>
<member name="E:HTTPApp.HTTPApp.BeforeDispatch">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs before the dispatcher tries to match the HTTP request message with any of its action items.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write a <event namespace="HTTPApp" class="TCustomWebDispatcher">BeforeDispatch</event> event handler to preprocess all HTTP request messages. A <event namespace="HTTPApp" class="TCustomWebDispatcher">BeforeDispatch</event> event handler can enable or disable the action items appropriate to the response, begin filling out the response object, or provide any other necessary preprocessing. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the <event namespace="HTTPApp" class="TCustomWebDispatcher">BeforeDispatch</event> event handler finishes filling out the response object, it should change the Handled parameter to True so the dispatcher will not send the request on to any of the action items. If the <event namespace="HTTPApp" class="TCustomWebDispatcher">BeforeDispatch</event> event handler sends the response message, the dispatcher will not pass the request on to any of the action items, even if the Handled parameter is left as False.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the <event namespace="HTTPApp" class="TCustomWebDispatcher">BeforeDispatch</event> event handler sets the Handled parameter to True but does not send the response, the Web dispatcher will generate an AfterDispatch event.</para>
</comments>
</member>
<member name="E:HTTPApp.HTTPApp.AfterDispatch">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs after the HTTP response message has been successfully filled out by the action items but not yet sent.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="HTTPApp" class="TCustomWebDispatcher">AfterDispatch</event> event handler to provide a final check of the HTTP response message before it is sent to the Web client. An <event namespace="HTTPApp" class="TCustomWebDispatcher">AfterDispatch</event> event handler can let a response stand as is, change the response, send the response, or change the Handled parameter to False to prevent the Web application from sending the response.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <event namespace="HTTPApp" class="TCustomWebDispatcher">AfterDispatch</event> event does not occur if all of the action items indicate that the response was not handled, or if the response is sent by any of the action items.</para>
</comments>
</member>
<member name="E:HTTPApp.HTTPApp.OnException">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when an unhandled exception occurs in the application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <event namespace="HTTPApp" class="TCustomWebDispatcher">OnException</event> to change the default behavior that occurs when an exception is not handled by application code. The <event namespace="HTTPApp" class="TCustomWebDispatcher">OnException</event> event handler is called automatically in the HandleException method. </para>
<event namespace="HTTPApp" class="TCustomWebDispatcher">OnException</event> only handles exceptions that occur during message processing. Exceptions that occur before or after the execution of the application's Run method do not generate <event namespace="HTTPApp" class="TCustomWebDispatcher">OnException</event> events.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If an exception passes through the try blocks in the application code, the application automatically calls the HandleException method. Unless the exception object is EAbort, HandleException calls the <event namespace="HTTPApp" class="TCustomWebDispatcher">OnException</event> handler, if one exists. Otherwise, it calls ShowException to display a message box indicating an error occurred.</para>
<class namespace="HTTPApp">TWebDispatcher</class> passes HTTP request messages on to the appropriate action items that assemble a response.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="HTTPApp">TWebDispatcher</class> to convert an ordinary data module to a Web module. Add a <class namespace="HTTPApp">TWebDispatcher</class> object to an existing data module that contains other nonvisual components and business rules for the Web application. Then delete the automatically generated Web module from the Web application and replace it with the data module that now contains the Web dispatcher.</para>
<class namespace="HTTPApp">TWebDispatcher</class> enables the Web server application to respond to HTTP request messages. Only one Web dispatcher can be added to an application. This is why the automatically generated Web module, which is a type of Web dispatcher, must be deleted from the Web application before the data module containing <class namespace="HTTPApp">TWebDispatcher</class> can be added.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <class namespace="HTTPApp">TWebDispatcher</class> object manages a collection of action items which know how to respond to HTTP request messages. View, add, and delete the action items managed by the dispatcher using the Action editor which is opened by double-clicking on the <class namespace="HTTPApp">TWebDispatcher</class> icon.</para>
<class namespace="HTTPApp">TWebDispatcher</class> publishes some of the properties and events introduced by TCustomWebDispatcher, but introduces no new properties, events, or methods of its own.</para>
<class namespace="HTTPApp">TWebModule</class> is the automatically generated Web module for a Web server application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When a new Web application is created, it automatically contains a Web module. The Web module serves as a repository for nonvisual components such as TPageProducer, TSQLDataSet, TDataSetTableProducer, etc. It also enables the Web server application to respond to HTTP request messages by passing the request and response objects to the appropriate action items. An application can have only one Web module.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <class namespace="HTTPApp">TWebModule</class> object manages a collection of action items which know how to respond to HTTP request messages. View, add and delete the action items managed by the Web module using the Action editor which is opened by double clicking on the <class namespace="HTTPApp">TWebModule</class> icon.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If a data module already exists which contains many of the non-visual components and business rules for the application, the Web module can be replaced by that data module. Simply delete the Web module, add the new data module in its place, and add a TWebDispatcher object to the new data module.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">See the WebServ demo for an example of how to use <class namespace="HTTPApp">TWebModule</class>.</para>
<para>When you create a new Apache module project and save it with a new name, it may be necessary to change the name of the apache_module (in the exports section of the project source code) by hand. </para>
<method namespace="HTTPApp" class="TWebModule">Create</method>s an instance of <method namespace="HTTPApp" class="TWebModule">TWebModule</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances at runtime. The Web module is created automatically when a Web application project is created at design time. Every time a Web server application is run in response to an HTTP request message, a new <method namespace="HTTPApp" class="TWebModule">TWebModule</method> is created based on the Web module that was created at design time.</para>
<method namespace="HTTPApp" class="TWebModule">Create</method> generates an On<method namespace="HTTPApp" class="TWebModule">Create</method> event, so that Web applications can initialize the Web module before the new HTTP request message is processed.</para>
<class namespace="HTTPApp">TAbstractWebModuleFactory</class> is the base class for all Web module factory objects.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All WebSnap modules are registered with the WebSnap application using a factory object. In Delphi, the factory object is typically created in the initialization section of the module source file. The factory object is responsible for creating Web module instance. Applications can set flags for each factory object to indicate when it should create instances of its Web module and whether it can cache Web module instance for reuse with subsequent request messages. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="HTTPApp">TAbstractWebModuleFactory</class>. Most of its methods are abstract or, in C++ terminology, pure virtual, meaning they have no implementation. Instead, create instances of a <class namespace="HTTPApp">TAbstractWebModuleFactory</class> descendant such as TWebDataModuleFactory, TWebAppDataModuleFactory, TWebPageModuleFactory, or TWebAppPageModuleFactory. Each of these classes includes an implementation of the abstract or pure virtual methods, and represents group of Web module factories. These groups are based on whether the Web module factory generates the single application Web module (which contains the components to dispatch HTTP request messages), and it generates a Web module that creates a Web page. </para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.GetModule">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates an instance of the associated Web module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TAbstractWebModuleFactory">GetModule</method> to obtain a new instance of the Web module that the factory creates. This method should only be called once for each request message that requires the use of the Web module.</para>
<method namespace="HTTPApp" class="TAbstractWebModuleFactory">GetModule</method> returns the Web module instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TAbstractWebModuleFactory">TAbstractWebModuleFactory</method>, <method namespace="HTTPApp" class="TAbstractWebModuleFactory">GetModule</method> is abstract or, in C++ terminology, pure virtual, meaning it has no implementation. Descendant classes must override this method to provide an implementation that creates a new Web module instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Prevents the WebSnap application from freeing the Web module instance.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TAbstractWebModuleFactory">PreventDestruction</method> if the WebSnap application should not free the Web module instance when the current HTTP request message has been fully processed. For example, if another Web module contains a reference to the Web module that this factory creates, you may not want to allow the WebSnap application to free the Web module that this factory creates while the other module exists.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="HTTPApp" class="TAbstractWebModuleFactory">TAbstractWebModuleFactory</method>, <method namespace="HTTPApp" class="TAbstractWebModuleFactory">PreventDestruction</method> is abstract or, in C++ terminology, pure virtual, meaning it has no implementation. Descendant classes must override this method to provide an implementation that prevents the Web module from being freed.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ModuleName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the Web module class that this factory instantiates.</para>
<property namespace="HTTPApp" class="TAbstractWebModuleFactory">ModuleName</property> is the name of the Web module class that the factory object instantiates. That is, this is the name of the class for which the ComponentClass property is a class reference.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.IsAppModule">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the corresponding Web module is the main Web application module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WebSnap applications read <property namespace="HTTPApp" class="TAbstractWebModuleFactory">IsAppModule</property> to determine whether a Web module factory creates the single application module. WebSnap applications include one and only one application module, which holds the components responsible for dispatching HTTP requests. The Web application module is an instance of TWebAppPageModule or TWebAppDataModule.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ComponentClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the class type of the Web module that this factory creates.</para>
<property namespace="HTTPApp" class="TAbstractWebModuleFactory">ComponentClass</property> is the class type of the Web module that the factory object creates. This is a descendant of TWebDataModule, TWebAppDataModule, TWebPageModule, or TWebAppPageModule. The WebSnap application wizard or Web module wizard generates the class declaration for the specific Web module class associated with a Web module factory.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.CreateMode">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates when the factory creates instances of its Web module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebModuleFactory">CreateMode</property> to determine whether the factory creates its Web module for every request message (crAlways), or when the WebSnap application specifically needs the Web module for the current request (crOnDemand).</para>
<para>When the Web module factory creates the Web application module, <property namespace="HTTPApp" class="TAbstractWebModuleFactory">CreateMode</property> is always crAlways. The Web application module is always required because it contains the components that dispatch HTTP messages. For Web module factories that create any other Web modules in the application, <property namespace="HTTPApp" class="TAbstractWebModuleFactory">CreateMode</property> reflects a flag passed to the constructor.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.CacheMode">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the factory can cache Web modules for reuse.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Web module factory creates an instance of its Web module to handle a specific HTTP request message. After the WebSnap application has finished with that request, it can free the Web module instance, or cache it so that the next time it needs to create an instance of its Web module, it can simply reuse the cached instance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="HTTPApp" class="TAbstractWebModuleFactory">CacheMode</property> is caCache, the WebSnap application caches Web module instances for reuse. This can improve performance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="HTTPApp" class="TAbstractWebModuleFactory">CacheMode</property> is caDestroy, the WebSnap application frees Web module instances when they are no longer needed for the current request message. This is the safest approach if changes to the Web module or any of the components it contains that are made while processing a request message can interfere with the correct handling of subsequent request messages.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.WebPageInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes the attributes of the Web page that the corresponding Web module generates, if any.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the Web module that the factory object creates can generate a Web page, <property namespace="HTTPApp" class="TAbstractWebModuleFactory">WebPageInfo</property> describes the attributes of the Web page, such as its name, title, access rights, and so on. This information is stored in the Web module factory so that it is available even when there is no current instance of the Web module.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the Web module that the factory object creates does not generate a Web page, <property namespace="HTTPApp" class="TAbstractWebModuleFactory">WebPageInfo</property> is nil (Delphi) or NULL (C++).</para>
<class namespace="HTTPApp">TAbstractWebPageModuleFactory</class> is the base class for Web module factory objects whose generated Web modules create Web pages.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All WebSnap modules are registered with the WebSnap application using a factory object. In Delphi, the factory object is typically created in the initialization section of the module source file. The factory object is responsible for creating Web module instances. Applications can set flags for each factory object to indicate when it should create instances of its Web module and whether it can cache Web module instances for reuse with subsequent request messages.</para>
<class namespace="HTTPApp">TAbstractWebPageModuleFactory</class> is the base class for all Web module factory objects that generate Web page modules. In addition to holding components that perform tasks for the WebSnap application, Web page modules can generate a Web page. The Web page is described by a Web page information object, which the Web page module factory makes available as its WebPageInfo property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="HTTPApp">TAbstractWebPageModuleFactory</class>. Most of its methods are abstract or, in C++ terminology, pure virtual, meaning they have no implementation. Instead, create instances of a <class namespace="HTTPApp">TAbstractWebPageModuleFactory</class> descendant such as TWebPageModuleFactory or TWebAppPageModuleFactory. </para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.GetWebPageInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the value of the WebPageInfo property.</para>
<method namespace="HTTPApp" class="TAbstractWebPageModuleFactory">GetWebPageInfo</method> is the protected read implementation of the WebPageInfo property. It returns the Web page information object that is supplied to the <method namespace="HTTPApp" class="TAbstractWebPageModuleFactory">TAbstractWebPageModuleFactory</method> constructor.</para>
<condition language="CBuilder">Do not create instances of <method namespace="HTTPApp" class="TAbstractWebPageModuleFactory">TAbstractWebPageModuleFactory</method>. Instead, construct descendants of <method namespace="HTTPApp" class="TAbstractWebPageModuleFactory">TAbstractWebPageModuleFactory</method> using the new keyword, passing any arguments for the descendant object's constructor.</condition>
<condition language="CBuilder">Descendant objects usually define a constructor that creates the particular kind of object and initializes its data.</condition>
<condition language="CBuilder">If an exception escapes from a constructor, the object's destructor is called to clean up the failed instance.</condition>
<condition language="CBuilder">Do not call ~<method namespace="HTTPApp" class="TAbstractWebPageModuleFactory">TAbstractWebPageModuleFactory</method> directly. Instead, use the delete keyword when destroying VCL objects.</condition>
<condition language="CBuilder">~<method namespace="HTTPApp" class="TAbstractWebPageModuleFactory">TAbstractWebPageModuleFactory</method> deallocates memory. Descendant objects usually define a destructor that is customized for that particular kind of object.</condition>
<condition language="CBuilder">If an exception escapes from the constructor, the destructor is called to destroy the partially constructed object instance that failed to initialize completely. Therefore, destructors should check that allocated resources, such as handles, were actually allocated before trying to release them, since their value might be zero.</condition>
<condition language="CBuilder">Never destroy a component from one of its own event handlers or from the event handler of a component it owns or contains. For example, don't destroy a button, or the form that owns the button, in the button's OnClick event handler.</condition>
<condition language="CBuilder">To destroy a form, call its Release method, which destroys the form and releases the memory allocated for it after all its event handlers and those of the components it contains have executed.</condition>
<class namespace="HTTPApp">TAbstractWebPageInfo</class> is the abstract base class for Web page information objects. It introduces a number of properties that describe the attributes of a Web page module, including</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">PageName, which is the logical name for the Web page the module generates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">IsPublished, which indicates whether the WebSnap application automatically displays the page in response to request messages where the pathinfo portion of the target URL matches PageName. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">IsLoginRequired, which indicates whether the user must log in to access the Web page.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ViewAccess, which can be used to restrict access to the Web page.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">PageTitle, which is the title that appears on the Web page.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">PageFile, which identifies an associated HTML template that the Web page module uses to generate its Web page.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">PageHREF, which identifies the HREF to use for references to the page that appear in hypertext links.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">PageDescription, which describes the Web page.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="HTTPApp">TAbstractWebPageInfo</class>. It includes abstract or, in C++ terminology, pure virtual methods (methods that have no implementation) that must be overridden in a descendant class.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Web page information objects are used to set the attributes of a Web page module. An instance of a <class namespace="HTTPApp">TAbstractWebPageInfo</class> descendant, such as TWebPageInfo, is supplied to the constructor of the factory object that creates instances of the Web page module. Typically, the code to create this object and supply it to the Web page factory's constructor is generated by a Web page module wizard. You can change this generated code, which appears in the generated unit for the Web page module, to alter the properties of the Web page information object. For example, you may want to add a ViewAccess string to allow your application to limit access to the Web page.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In a WebSnap application, you can access the Web page information object of any Web page module by calling the FindPageInfo method of the application's global Web context.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.PageHREF">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies the HREF to use for references to the associated Web page that appear in hypertext links.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageHREF</property> to obtain the string that should be inserted in HTML code to create a hypertext link to the associated Web page.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <property namespace="HTTPApp" class="TAbstractWebPageInfo">TAbstractWebPageInfo</property>, <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageHREF</property> is the same as the value of the PageName property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.PageDescription">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes the Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageDescription</property> to obtain a brief description of the Web page that the associated Web page module generates. This property can be used, for example, to provide descriptions for a dynamically generated catalog of available Web pages.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <property namespace="HTTPApp" class="TAbstractWebPageInfo">TAbstractWebPageInfo</property>, <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageDescription</property> is the same as the value of the PageName property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.PageTitle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the title that appears on the associated Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageTitle</property> to determine the title that appears on the associated Web page when viewed from a user's browser. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <property namespace="HTTPApp" class="TAbstractWebPageInfo">TAbstractWebPageInfo</property>, <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageTitle</property> is the same as the value of the PageName property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.PageName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Denotes the logical name for the Web page that the associated module generates</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageName</property> to determine the name of the associated Web page. This name is used to identify that page in server-side scripts, and as the pathinfo portion of the URL for the page when the IsPublished property is true. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <property namespace="HTTPApp" class="TAbstractWebPageInfo">TAbstractWebPageInfo</property>, the property read access method for <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageName</property> is <condition language="Delphi">abstract</condition>
<condition language="CBuilder">pure virtual</condition>. Descendant classes must override the protected Get<property namespace="HTTPApp" class="TAbstractWebPageInfo">PageName</property> method to provide an implementation for this property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.IsPublished">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the WebSnap application automatically displays the associated page in response to request messages where the pathinfo portion of the target URL matches PageName. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebPageInfo">IsPublished</property> to determine whether the page dispatcher (TPageDispatcher) automatically calls on the associated Web page module when it receives HTTP request messages that address it by name. HTTP request messages address a Web page module when the pathinfo portion of their target URL matches the value of the PageName property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="HTTPApp" class="TAbstractWebPageInfo">IsPublished</property> is false, the WebSnap application must explicitly retrieve the content that the Web page module generates in order to use the Web page module. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <property namespace="HTTPApp" class="TAbstractWebPageInfo">TAbstractWebPageInfo</property>, <property namespace="HTTPApp" class="TAbstractWebPageInfo">IsPublished</property> is always false. Descendant classes override this property, initializing it to a value that is passed to the constructor.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.IsLoginRequired">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether callers must log in before accessing the associated Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebPageInfo">IsLoginRequired</property> to determine whether users must log in before accessing the associated Web page. The page dispatcher component (TPageDispatcher) checks this value to determine whether it can forward requests to the associated Web page when the caller has not yet logged in. The application can overrule the <property namespace="HTTPApp" class="TAbstractWebPageInfo">IsLoginRequired</property> property by supplying an On<property namespace="HTTPApp" class="TAbstractWebPageInfo">IsLoginRequired</property> event handler to the page dispatcher.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <property namespace="HTTPApp" class="TAbstractWebPageInfo">TAbstractWebPageInfo</property>, <property namespace="HTTPApp" class="TAbstractWebPageInfo">IsLoginRequired</property> is always false. Descendant classes override this property, initializing it to a value that is passed to the constructor.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.PageFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies an associated file that the Web page module uses to generate its Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageFile</property> to identify the file, if any, that the associated Web page module uses when generating its Web page. This can be the Web page that the Web page module returns, or it can be a template that the Web page module modifies to generate its final product.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <property namespace="HTTPApp" class="TAbstractWebPageInfo">TAbstractWebPageInfo</property>, the property read access method for <property namespace="HTTPApp" class="TAbstractWebPageInfo">PageFile</property> is <condition language="Delphi">abstract</condition>
<condition language="CBuilder">pure virtual</condition>. Descendant classes must override the protected Get<property namespace="HTTPApp" class="TAbstractWebPageInfo">PageFile</property> method to provide an implementation for this property.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ViewAccess">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the view access string that controls access to the associated Web page.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebPageInfo">ViewAccess</property> to obtain the view access string that controls which users have access to the associated Web page. When a user tries to access the associated Web page, the page dispatcher checks the user's access rights against this string by calling the HasViewRights method of the end user adapter. Adapters in the Web page module check execute and modify rights against this string by calling the HasExecuteRights and HasModifyRights methods of the end user adapter. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <property namespace="HTTPApp" class="TAbstractWebPageInfo">TAbstractWebPageInfo</property>, <property namespace="HTTPApp" class="TAbstractWebPageInfo">ViewAccess</property> is always an empty string. Descendant classes override this property, initializing it to a value that is passed to the constructor.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Factory">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the factory object that creates instances of the Web page module this object describes.</para>
<property namespace="HTTPApp" class="TAbstractWebPageInfo">Factory</property> indicates the factory object that creates instances of the associated Web page module. If the associated Web page module is also the Web application module, <property namespace="HTTPApp" class="TAbstractWebPageInfo">Factory</property> is an instance of TWebAppPageModule<property namespace="HTTPApp" class="TAbstractWebPageInfo">Factory</property>. Otherwise, it is an instance of TWebPageModule<property namespace="HTTPApp" class="TAbstractWebPageInfo">Factory</property>. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">This property is set by the factory object's constructor.</para>
<class namespace="HTTPApp">TAbstractWebModuleList</class> lists the WebModules in a WebSnap application and provides access to their factory objects.</para>
<class namespace="HTTPApp">TAbstractWebModuleList</class> is the base class for TWebModuleList, which lists every Web module that has been instantiated to serve the current request. It introduces properties and methods for accessing the Web modules in the application, as well as for the Web module factory objects that create those Web module instances. All the methods in <class namespace="HTTPApp">TAbstractWebModuleList</class> are abstract or, in C++ terminology, pure virtual, meaning they have no implementation. TWebModuleList, a <class namespace="HTTPApp">TAbstractWebModuleList</class> descendant, overrides those abstract or pure virtual methods to provide a default implementation.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When a WebSnap application handles multiple requests concurrently, it includes multiple web modules lists, each on a separate thread and each associated with a different request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Web context, which can be accessed using the global WebContext function, provides access to the <class namespace="HTTPApp">TAbstractWebModuleList</class> object that is associated with the current request. Use the Web context's WebModules property to obtain a reference to the Web module list.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.FindModuleClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Locates a Web module given its class reference.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TAbstractWebModuleList">FindModuleClass</method> to locate the Web module instance of a given class type. <method namespace="HTTPApp" class="TAbstractWebModuleList">FindModuleClass</method> searches the Items property array for a Web module instance of the specified class. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AClass is a class reference to the class type of the desired Web module.</para>
<method namespace="HTTPApp" class="TAbstractWebModuleList">FindModuleClass</method> returns the requested Web module instance if it exists. If there is no Web module of the specified class, <method namespace="HTTPApp" class="TAbstractWebModuleList">FindModuleClass</method> returns nil (Delphi) or NULL (C++).</para>
<para>In <method namespace="HTTPApp" class="TAbstractWebModuleList">TAbstractWebModuleList</method>, <method namespace="HTTPApp" class="TAbstractWebModuleList">FindModuleClass</method> is abstract or, in C++ terminology, pure virtual, meaning it has no implementation. Descendant classes override this method to provide an implementation.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.FindModuleName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Locates a Web module given its name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HTTPApp" class="TAbstractWebModuleList">FindModuleName</method> to locate the Web module instance of a given name. FindModuleClass searches the Items property array for a Web module instance of the specified name. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AName is the name of the desired Web module.</para>
<method namespace="HTTPApp" class="TAbstractWebModuleList">FindModuleName</method> returns the requested Web module instance if it exists. If there is no Web module with the specified name, FindModuleClass returns nil (Delphi) or NULL (C++).</para>
<para>In <method namespace="HTTPApp" class="TAbstractWebModuleList">TAbstractWebModuleList</method>, FindModuleClass is abstract or, in C++ terminology, pure virtual, meaning it has no implementation. Descendant classes override this method to provide an implementation.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.AddModuleClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a new Web module, given its class, and adds it to the Items property array.</para>
<method namespace="HTTPApp" class="TAbstractWebModuleList">AddModuleClass</method> searches for a Web module factory that can create a Web module of the specified class. If it finds a match, it instantiates the Web module and adds it to the Items property array.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AClass is a class reference to the Web module you want to instantiate. It should not match the class type of any Web module already listed in the Items property array.</para>
<method namespace="HTTPApp" class="TAbstractWebModuleList">AddModuleClass</method> returns the new Web module instance. If the Factory property array does not include a Web module factory that can create a Web module of the specified class, <method namespace="HTTPApp" class="TAbstractWebModuleList">AddModuleClass</method> returns nil (Delphi) or NULL (C++).</para>
<para>In <method namespace="HTTPApp" class="TAbstractWebModuleList">TAbstractWebModuleList</method>, <method namespace="HTTPApp" class="TAbstractWebModuleList">AddModuleClass</method> is abstract or, in C++ terminology, pure virtual, meaning it has no implementation. Descendant classes override this method to provide an implementation.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.HTTPApp.AddModuleName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a new Web module, given its name, and adds it to the Items property array.</para>
<method namespace="HTTPApp" class="TAbstractWebModuleList">AddModuleName</method> searches for a Web module factory that can create a Web module of the specified name. If it finds a match, it instantiates the Web module and adds it to the Items property array.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AName is the name of the Web module you want to instantiate. It should not match the name of any Web module already listed in the Items property array.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AddModuleClass returns the new Web module instance. If the Factory property array does not include a Web module factory that can create a Web module of the specified name, AddModuleClass returns nil (Delphi) or NULL (C++).</para>
<para>In <method namespace="HTTPApp" class="TAbstractWebModuleList">TAbstractWebModuleList</method>, <method namespace="HTTPApp" class="TAbstractWebModuleList">AddModuleName</method> is abstract or, in C++ terminology, pure virtual, meaning it has no implementation. Descendant classes override this method to provide an implementation.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Items">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the instantiated Web modules in the current thread.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebModuleList">Items</property> to access the Web modules that have been created to process the current HTTP request. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the ItemCount property in conjunction with <property namespace="HTTPApp" class="TAbstractWebModuleList">Items</property> to iterate over all the Web modules in the current thread.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">I is the index of the object to read, where 0 identifies the first Web module, 1 identifies the second Web module, and so on, until ItemCount ΓÇô 1 identifies the last Web module. </para>
<para>In Delphi, <property namespace="HTTPApp" class="TAbstractWebModuleList">Items</property> is the default property of <property namespace="HTTPApp" class="TAbstractWebModuleList">TAbstractWebModuleList</property>. This means that the property name may be omitted. Thus the line </para>
<para>In C++, a similar effect to the use of <property namespace="HTTPApp" class="TAbstractWebModuleList">Items</property> as a default property can be achieved using the [] operator.</para>
</note>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.ItemCount">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of Web modules that have been instantiated in the current thread.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebModuleList">ItemCount</property> to determine the number of instantiated Web modules in the current thread of the WebSnap application. <property namespace="HTTPApp" class="TAbstractWebModuleList">ItemCount</property> provides an upper bound to the index of the Items property array.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Because <property namespace="HTTPApp" class="TAbstractWebModuleList">ItemCount</property> counts only the instantiated Web modules, its value is always less than or equal to the value of FactoryCount, which gives the number of Web module factories.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.FactoryCount">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of Web module factories listed in the Factory property array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebModuleList">FactoryCount</property> to determine the number of Web module factory object (and hence the potential number of Web modules) in the WebSnap application. <property namespace="HTTPApp" class="TAbstractWebModuleList">FactoryCount</property> provides an upper bound to the index of the Factory property array.</para>
</comments>
</member>
<member name="P:HTTPApp.HTTPApp.Factory">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the Web module factories for all the Web modules available in the application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="HTTPApp" class="TAbstractWebModuleList">Factory</property> to access the factory objects that instantiate Web modules for the WebSnap application. Each factory object includes methods to create or (if an instance exists) access the corresponding Web module, as well as properties that provide information about the Web module it creates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the <property namespace="HTTPApp" class="TAbstractWebModuleList">Factory</property>Count property in conjunction with <property namespace="HTTPApp" class="TAbstractWebModuleList">Factory</property> to iterate over all the Web module factory objects in the WebSnap application.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">I is the index of the factory object to read, where 0 identifies the first factory, 1 identifies the second factory, and so on, until <property namespace="HTTPApp" class="TAbstractWebModuleList">Factory</property>Count ΓÇô 1 identifies the last factory. </para>
</comments>
</member>
<member name="E:HTTPApp.HTTPApp.OnModuleAdded">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a new Web module is added to the Items property array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="HTTPApp" class="TAbstractWebModuleList">OnModuleAdded</event> event handler to take specific action when a Web module is instantiated in the current Web context. When the WebSnap application creates a new Web module instance, it generates an <event namespace="HTTPApp" class="TAbstractWebModuleList">OnModuleAdded</event> event immediately after adding the instance to the Items property array.</para>
<para>Do not write an <event namespace="HTTPApp" class="TAbstractWebModuleList">OnModuleAdded</event> event handler if the application contains a TWebAppComponents object. TWebAppComponents uses this event to initialize the Web modules when they are added. </para>
<class namespace="HTTPApp">EWebBrokerException</class> is raised when a WebBroker object encounters a problem. It functions identically to its parent class, TException.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPDecode">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Decodes a string that includes HTTP escape characters.</para>
<routine namespace="HTTPApp">HTTPDecode</routine> decodes the escape characters (+ and %) in a string that comes from an HTTP message header. Plus characters (+) are converted into spaces. Percent signs (%) indicate that the next two characters are the hex representation of a character. If a percent sign is followed by another percent sign (%%), it is converted into a single percent sign.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, the string</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The AStr parameter is the undecoded string. The return value is the converted version of the string.</para>
</comments>
</member>
<member name="M:HTTPApp.HTTPEncode">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Converts a string into a form that contains no values that are illegal in an HTTP message header.</para>
<routine namespace="HTTPApp">HTTPEncode</routine> converts all characters in the AStr parameter except for the letters A through Z (and a through z), numerals 0 through 9, the asterisk (*), dollar sign ($), exclamation point (!), at sign (@), period (.), underscore (_), single quote ('), comma (,) parentheses, and hyphen (-). Spaces are converted to plus characters (+), and all other characters are converted into hex values preceded by the percent sign (%).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, the string</para>
<routine namespace="HTTPApp">HTTPEncode</routine> returns the converted string.</para>
</comments>
</member>
<member name="M:HTTPApp.ParseDate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Converts a date value from an HTTP message header into a TDateTime.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">HTTP message headers permit several formats for the representation of date and time values. <routine namespace="HTTPApp">ParseDate</routine> converts from any of these formats into a TDateTime. <routine namespace="HTTPApp">ParseDate</routine> allows server applications to work with date values taken from HTTP request messages, without worrying about the details of how they are formatted.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="HTTPApp">ParseDate</routine> when interpreting temporal header values in HTTP request messages when they are not already parsed as a property of TWebRequest. TWebRequest parses the Date header and Expires header automatically.</para>
</comments>
</member>
<member name="M:HTTPApp.ExtractHeaderFields">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Parses a multi-valued string into its constituent fields.</para>
<routine namespace="HTTPApp">ExtractHeaderFields</routine> is a general utility to parse multi-valued HTTP header strings into separate substrings. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Separators is a set of characters that are used to separate individual values within the multi-valued string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WhiteSpace is a set of characters that are to be ignored when parsing the string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Content is the multi-valued string to be parsed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Strings is the TStrings object that receives the individual values that are parsed from Content. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">StripQuotes determines whether the surrounding quotes are removed from the resulting items. When StripQuotes is true, surrounding quotes are removed before substrings are added to Strings.</para>
<para>Characters contained in Separators or WhiteSpace are treated as part of a value substring if the substring is surrounded by single or double quote marks. HTTP escape characters are converted using the HTTPDecode function.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.ExtractHTTPFields">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Parses a multi-valued string into its constituent fields.</para>
<routine namespace="HTTPApp">ExtractHTTPFields</routine> is a general utility to parse multi-valued HTTP header strings into separate substrings. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Separators is a set of characters that are used to separate individual values within the multi-valued string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WhiteSpace is a set of characters that are to be ignored when parsing the string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Content is the multi-valued string to be parsed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Strings is the TStrings object that receives the individual values that are parsed from Content. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">StripQuotes determines whether the surrounding quotes are removed from the resulting items. When StripQuotes is true, surrounding quotes are removed before substrings are added to Strings.</para>
<para>Characters contained in Separators or WhiteSpace are treated as part of a value substring if the substring is surrounded by single or double quote marks. HTTP escape characters are converted using the HTTPDecode function.</para>
</note>
</comments>
</member>
<member name="M:HTTPApp.StatusString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the explanatory string associated with one of the predefined HTTP response status codes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HTTP protocol specification defines a number of standard status codes that indicate the status of an HTTP request message. HTTP applications interpret these status codes, but for human beings, each of these codes has a corresponding string that provides a more understandable indication of the status of the HTTP request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="HTTPApp">StatusString</routine> to obtain the string that corresponds to a standard status code. If the StatusCode parameter is not one of the codes defined in the HTTP standard, <routine namespace="HTTPApp">StatusString</routine> returns an empty string.</para>
</comments>
</member>
<member name="M:HTTPApp.UnixPathToDosPath">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Converts a Unix-compatible path specification to a Dos-compatible path specification.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="HTTPApp">UnixPathToDosPath</routine> to convert a path name obtained from an HTTP message or other Unix-based application to a path name that can be used by Windows. <routine namespace="HTTPApp">UnixPathToDosPath</routine> converts all forward slashes (/) to backslash characters (\).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Path parameter is the Unix-compatible path. The return value is the corresponding Dos-compatible path.</para>
</comments>
</member>
<member name="M:HTTPApp.DosPathToUnixPath">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Converts a DOS-compatible path specification to a Unix-compatible path specification.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="HTTPApp">DosPathToUnixPath</routine> to convert a path name on the local machine to a path name that can be sent in an HTTP message, or that will be used by a Unix-based application. <routine namespace="HTTPApp">DosPathToUnixPath</routine> converts all backslash characters (\) to forward slashes (/).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Path parameter is the Dos-compatible path. The return value is the corresponding Unix-compatible path.</para>
</comments>
</member>
<member name="M:HTTPApp.MonthStr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Converts a TDateTime into a string representing the month.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">HTTP message headers permit several formats for the representation of date and time values. <routine namespace="HTTPApp">MonthStr</routine> converts a TDateTime into a string representing the month. <routine namespace="HTTPApp">MonthStr</routine> allows server applications to work with date values taken from HTTP request messages, without worrying about the details of how they are formatted.</para>
</comments>
</member>
<member name="M:HTTPApp.DayOfWeekStr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Converts a TDateTime into a string representing the day of the week.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">HTTP message headers permit several formats for the representation of date and time values. <routine namespace="HTTPApp">DayOfWeekStr</routine> converts a TDateTime into a string representing the day of the week. <routine namespace="HTTPApp">DayOfWeekStr</routine> allows server applications to work with date values taken from HTTP request messages, without worrying about the details of how they are formatted.</para>
