Page tree
Skip to end of metadata
Go to start of metadata

Sets all or part of a navigation item

Syntax

Parameters

hItem
Type: NavHandle
The NavHandle of the item to set
pItem
Type: NAVSETITEM *

The structure that contains the new information to set into the item. Only those fields that are specified in pItem->mask will be set. The rest will be left unmodified.

For NI_MASK_LABEL and NI_MASK_DESCRIPTION, you can specify NULL for the field value and it will be set to the empty string.

Return Value

Type: bool
If the information set contained an item that affects how it is viewed, then true is returned. Otherwise false is returned.

Remarks

To use this function, set the mask field of pItem to declare what fields you want set. For a description of the NAVSETITEM mask options, see NavInsertItem

Examples

None

See Also

NavGetItemEx

NavInsertItem

NavSetItem