IVsObjectList2.LocateNavigationInfo2 Method (VSOBNAVIGATIONINFO3[], VSOBNAVNAMEINFONODE2[], Int32, Int32, UInt32)

 

Returns the index of the list item corresponding to the VSOBNAVIGATIONINFO2 structure.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

int LocateNavigationInfo2(
	VSOBNAVIGATIONINFO3[] pobNav,
	VSOBNAVNAMEINFONODE2[] pobName,
	int fDontUpdate,
	out int pfMatchedName,
	out uint pIndex
)

Parameters

pobNav
Type: Microsoft.VisualStudio.Shell.Interop.VSOBNAVIGATIONINFO3[]

[in] Specifies navigation information. Values are in a VSOBNAVIGATIONINFO2 structure.

pobName
Type: Microsoft.VisualStudio.Shell.Interop.VSOBNAVNAMEINFONODE2[]

[in] Specifies the name of the node of interest. Values are in a VSOBNAVNAMEINFONODE structure.

fDontUpdate
Type: System.Int32

[in] Flag indicating that no update should be made.

pfMatchedName
Type: System.Int32

[out] Pointer to a flag indicating a matched name was found.

pIndex
Type: System.UInt32

[out] Pointer to the index of the located item.

Return Value

Type: System.Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

From vsshell80.idl:

[C++]

HRESULT IVsObjectList2::LocateNavigationInfo2(
   [in] VSOBNAVIGATIONINFO3 *pobNav, 
   [in] VSOBNAVNAMEINFONODE2 *pobName, 
   [in] BOOL fDontUpdate, 
   [out] BOOL *pfMatchedName, 
   [out] ULONG *pIndex
);

When an object has been selected in Object Browser or Class View, and the environment must redraw the view as a result of a sort or expansion, a path back to the selected item must be maintained. The environment calls GetNavigationInfo2for the selected object, and each of its parents, ascending the tree until the root node is reached. The environment can then descend the tree, with calls to LocateNavigationInfo2 to step down through the nodes of the tree list. The VSOBNAVIGATIONINFO2 structure contains the GUID and name of the library. The pobName parameter is a pointer to a VSOBNAVNAMEINFONODE structure containing the name and type of the item of interest. When you find the requested name, set pIndex to the appropriate value for the item, and set pfMatchedName to true. If fDontUpdate is set, and you can't locate the requested item, return E_FAIL. If fDontUpdate is not set and you can't locate the requested item, return pIndex as null, and the environment regenerates the object list.

Return to top
Show: