IVsSimpleLibrary2::GetBrowseContainersForHierarchy Method (IVsHierarchy^, UInt32, array<VSBROWSECONTAINER>^, array<UInt32>^)

Visual Studio 2015

Returns an array of Browse Containers that correspond to the given IVsHierarchy.

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

Syntax

C++

int GetBrowseContainersForHierarchy(
	IVsHierarchy^ pHierarchy,
	unsigned int celt,
	array<VSBROWSECONTAINER>^ rgBrowseContainers,
	array<unsigned int>^ pcActual
)

Parameters

pHierarchy: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
[in] An IVsHierarchy object representing the hierarchy.

celt: Type: System::UInt32
[in] The number of elements in the rgBrowseContainers array.

rgBrowseContainers: Type: array<Microsoft.VisualStudio.Shell.Interop::VSBROWSECONTAINER>^
[in, out] On input, null. On output, an array of VSBROWSECONTAINER structures.

pcActual: Type: array<System::UInt32>^
[out] The actual number of containers that were returned in rgBrowseContainers.

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 vsshell80.idl:

C++

HRESULT IVsSimpleLibrary2::GetBrowseContainersForHierarchy(
   [in]                     IVsHierarchy      *pHierarchy, 
   [in]                     ULONG              celt, 
   [in, out, size_is(celt)] VSBROWSECONTAINER  rgBrowseContainers[], 
   [out, optional]          ULONG             *pcActual
);

The environment calls this method twice to obtain a list of browse containers corresponding to a given project hierarchy. In the first call, the environment sets celt and rgBrowseContainers to null. This method returns in the pcActual parameter the number of browse containers in the hierarchy pointed to be pHierarchy. The environment then allocates the rgBrowseContainers array and calls GetBrowseContainersForHierarchy again. With this call, the method fills the rgBrowseContainers array with VSBROWSECONTAINER structures identifying the browse containers within your hierarchy. Return a count in celt only if your package owns the requested hierarchy.

This method is meaningful only for libraries providing project browse containers.