IVsComponentEnumeratorFactory.GetComponents Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides an enumerator for all of the components in a package.

public:
 int GetComponents(System::String ^ bstrMachineName, int lEnumType, int bForceRefresh, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumComponents ^ % pEnumerator);

public:
 int GetComponents(Platform::String ^ bstrMachineName, int lEnumType, int bForceRefresh, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumComponents ^ &  pEnumerator);

int GetComponents(std::wstring const & bstrMachineName, int lEnumType, int bForceRefresh, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumComponents const & & pEnumerator);

public int GetComponents (string bstrMachineName, int lEnumType, int bForceRefresh, out Microsoft.VisualStudio.Shell.Interop.IEnumComponents pEnumerator);

abstract member GetComponents : string * int * int * IEnumComponents -> int

Public Function GetComponents (bstrMachineName As String, lEnumType As Integer, bForceRefresh As Integer, ByRef pEnumerator As IEnumComponents) As Integer

Parameters

bstrMachineName: String

[in] Reserved, must be null.

lEnumType: Int32

[in] Long integer containing the enumeration type. The value for this is from the CompEnum enumeration.

bForceRefresh: Int32

[in] Reserved, must be false.

pEnumerator: IEnumComponents

out] Pointer to an enumerator object. This returns the list of components. The list can be either COM-components, Visual Studio assemblies, or a list of directories in which Visual Studio looks for references. The type of components listed is determined by lEnumType.

Returns

Int32

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

Remarks

COM Signature

From compsvcspkg.idl:

HRESULT IVsComponentEnumeratorFactory::GetComponents(  
   [in] BSTR bstrMachineName,  
   [in] LONG lEnumType,  
   [in] BOOL bForceRefresh,  
   [out] IEnumComponents** pEnumerator  
);

Applies to

Share via