IVsComponentEnumeratorFactory.GetComponents Method

Article
2013-03-06

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

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

Syntax

'Declaration
Function GetComponents ( _
    bstrMachineName As String, _
    lEnumType As Integer, _
    bForceRefresh As Integer, _
    <OutAttribute> ByRef pEnumerator As IEnumComponents _
) As Integer

int GetComponents(
    string bstrMachineName,
    int lEnumType,
    int bForceRefresh,
    out IEnumComponents pEnumerator
)

int GetComponents(
    [InAttribute] String^ bstrMachineName, 
    [InAttribute] int lEnumType, 
    [InAttribute] int bForceRefresh, 
    [OutAttribute] IEnumComponents^% pEnumerator
)

abstract GetComponents : 
        bstrMachineName:string * 
        lEnumType:int * 
        bForceRefresh:int * 
        pEnumerator:IEnumComponents byref -> int

function GetComponents(
    bstrMachineName : String, 
    lEnumType : int, 
    bForceRefresh : int, 
    pEnumerator : IEnumComponents
) : int

Parameters

bstrMachineName
Type: System.String
[in] Reserved, must be nulla null reference (Nothing in Visual Basic).

lEnumType
Type: System.Int32
[in] Long integer containing the enumeration type. The value for this is from the CompEnum enumeration.

bForceRefresh
Type: System.Int32
[in] Reserved, must be false.

pEnumerator
Type: Microsoft.VisualStudio.Shell.Interop.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.

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

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via