TWebContext.FindPageInfo Method

Retrieves a Web page information object given the name of the corresponding Web page module.

Pascal

function FindPageInfo(const APage: string; AOptions: TFindPageOptions; out APageInfo: TAbstractWebPageInfo): Boolean; override;

C++

virtual __fastcall Boolean FindPageInfo(const AnsiString APage, TFindPageOptions AOptions, TAbstractWebPageInfo APageInfo);

Description

Call FindPageInfo to obtain the Web page information object for a Web page module. FindPageInfo 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.

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.

AOptions is a set of options that can limit the page modules that FindPageInfo considers. For any option included in this set, FindPageInfo only considers Web page modules that have the corresponding attribute.

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.

FindPageInfo returns false if it can't return a value for the APageInfo parameter. FindPageInfo returns true if it locates a registered Web page module with the specified name and attributes.