peoplecodeapi - GenerateHomepagePortalURL

Syntax

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

Description

Use the GenerateHomepagePortalURL function to create a URL string that represents an absolute reference the specified homepage tab on the portal servlet.

The PortalURI of the node that hosts the specified portal is used in the generated URL. The generated URL contains a reference to the portal service ( psp ) servlet.

If you want to generate a relative URL, use the GenerateHomepageRelativeURL 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. Note: The value specified for this parameter is ignored. The node name that is used is automatically calculated. However, you must still specify a value for this parameter.
`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:

http://Portal URI of host node/Portal/node/h/?tab=tabname

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