peoplecodeapi - GenerateHomepageRelativeURL

Syntax

GenerateHomepageRelativeURL(PORTAL.portalname, NODE.nodename, Tabname)

Description

Use the GenerateHomepageRelativeURL function to create a URL string that represents a relative reference the specified homepage on the portal servlet. The relative reference is suitable for use on any page that itself has the simple URL format.

If you want to generate an absolute URL, use the GenerateHomepagePortalURL function.

Parameters

Field or Control	Definition
`portalname`	Specify the name of the portal used for this request, prefixed with the reserved word PORTAL . You can also use a string, such as %Portal, for this value.
`nodename`	Specify the name of the node that contains the content, prefixed with the reserved word NODE . You can also use a string, such as %Node, for this value. . This should be the node that hosts the specified portal.
`Tabname`	Specify the name of the tab on the homepage that you want to generate a URL for. If you specify a null string (""), the default tab is used.

Returns

If the node has a Node Type of PIA, a string of the following format is returned:

../../../Portal/node/h/?tab=tabname

If the node has a Node Type of ICType, a string of the following format is returned:

./?cmd=start

This function returns a Null string if you specify an invalid portal or node.