IPageByUrlRetriever.TryRetrieve Method

Tries to retrieve a page based on given url.

Namespace: CMS.DocumentEngine.Internal
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

bool TryRetrieve(
	string url,
	SiteInfoIdentifier siteIdentifier,
	out TreeNode page
)

Parameters

url

Type: System.String
URL of a page to retrieve.

siteIdentifier

Type: CMS.DataEngine.SiteInfoIdentifier
Site identifier.

page

Type: CMS.DocumentEngine.TreeNode
If successful, represents a page available under given URL.

Return Value

Type: Boolean
Returns true in case a page with matching URL was found.

Remarks

The method reflects router mode setting. In case of Custom mode the method may not be able to find a corresponding page if URL pattern contains a complex macro.