MenuGetPageNode

Returns the handle to the menu tree for a specified page. Its child nodes represent the menu items that have the particular page specified in the menu configuration database.

Syntax

MenuGetPageNode(sPage [, nMode])

sPage:

The name of the page for which to return the menu tree handle.

nMode:

The mode to use for generating the menu handle for the page:

• 0 - Return the base node for the menu tree for the specified page if it exists, otherwise return -1 (do not create). Default value.
• 1 - Return the base node for the menu tree for the specified page. Create the menu tree if it does not already exist.
• 2 - Return a new duplicate of the menu tree for the specified page if it exists, otherwise return -1. Automatically dispose of the menu tree on page close.
• 3 - Return a new duplicate of the menu tree for the specified page if it exists, otherwise return -1. Do not automatically dispose of the menu tree. Call MenuNodeRemove() to remove menu tree.

Return Value

The handle of the menu tree, or -1 if no menu tree exists for a specified page.

Related Functions

MenuGetChild, MenuGetFirstChild, MenuGetGenericNode, MenuGetNextChild, MenuGetParent, MenuGetPrevChild, MenuGetWindowNode, MenuNodeAddChild, MenuNodeGetCurr, MenuNodeGetDepth, MenuNodeGetExpanded, MenuNodeGetProperty, Menu NodeGetTargetPage, MenuNodeHasCommand, MenuNodeIsDisabled, MenuNodeIsHidden, MenuNodeRemove, MenuNodeRunCommand, MenuNodeSetDisabledWhen, MenuNodeSetHiddenWhen, MenuNodeSetProperty, MenuReload

See Also

Menu Functions

Published June 2018