IVsObjectList.GetNavigationInfo Method

  • Article

Fills the VSOBNAVIGATIONINFO2 structure for the given list item allowing the list to navigate back to it through LocateNavigationInfo.

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

Syntax

'Declaration
Function GetNavigationInfo ( _
    index As UInteger, _
    <OutAttribute> pobNav As VSOBNAVIGATIONINFO2() _
) As Integer

int GetNavigationInfo(
    uint index,
    VSOBNAVIGATIONINFO2[] pobNav
)

int GetNavigationInfo(
    [InAttribute] unsigned int index, 
    [InAttribute] [OutAttribute] array<VSOBNAVIGATIONINFO2>^ pobNav
)

abstract GetNavigationInfo : 
        index:uint32 * 
        pobNav:VSOBNAVIGATIONINFO2[] byref -> int 

function GetNavigationInfo(
    index : uint, 
    pobNav : VSOBNAVIGATIONINFO2[]
) : int

Parameters

  • index
    Type: System.UInt32
    [in] Specifies the index of the list item of interest.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsObjectList::GetNavigationInfo(
   [in] ULONG Index,
   [in, out] VSOBNAVIGATIONINFO2 *pobNav
);

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 will call GetNavigationInfo for 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 LocateNavigationInfo to locate the originally selected object. The environment creates the pobNav structure and passes it to you. You fill pobNav with appropriate values for the index node, and return the structure to the environment. The structure is shown below for reference.

typedef struct _VSOBNAVIGATIONINFO2

{

GUID* pguididLib;

WCHAR* pszLibName;

VSOBNAVNAMEINFONODE* pName;

DWORD dwCustom;

}

Place the GUID of your library into pguididLib and the library name into pszLibName. These two parameters not usually change throughout the series of GetNavigationInfo calls. You may store any custom information in dwCustom. VSOBNAVNAMEINFONODE is a linked list structure that holds the name and type of each node in the navigation tree. Set these values appropriately for each GetNavigationInfo call. The environment handles the linked list addressing.

For more details on these structures see VSOBNAVIGATIONINFO2 and VSOBNAVNAMEINFONODE.

.NET Framework Security

See Also

Reference

IVsObjectList Interface

Microsoft.VisualStudio.Shell.Interop Namespace