IVsComponentSelectorDlg2.ComponentSelectorDlg2 Method

Article
2013-03-06

Displays Select Component Dialog and returns selected components.

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

Syntax

'Declaration
Function ComponentSelectorDlg2 ( _
    grfFlags As UInteger, _
    pUser As IVsComponentUser, _
    cComponents As UInteger, _
    rgpcsdComponents As IntPtr(), _
    lpszDlgTitle As String, _
    lpszHelpTopic As String, _
    <OutAttribute> ByRef pxDlgSize As UInteger, _
    <OutAttribute> ByRef pyDlgSize As UInteger, _
    cTabInitializers As UInteger, _
    rgcstiTabInitializers As VSCOMPONENTSELECTORTABINIT(), _
    <OutAttribute> ByRef pguidStartOnThisTab As Guid, _
    pszBrowseFilters As String, _
    <OutAttribute> ByRef pbstrBrowseLocation As String _
) As Integer

int ComponentSelectorDlg2(
    uint grfFlags,
    IVsComponentUser pUser,
    uint cComponents,
    IntPtr[] rgpcsdComponents,
    string lpszDlgTitle,
    string lpszHelpTopic,
    out uint pxDlgSize,
    out uint pyDlgSize,
    uint cTabInitializers,
    VSCOMPONENTSELECTORTABINIT[] rgcstiTabInitializers,
    out Guid pguidStartOnThisTab,
    string pszBrowseFilters,
    out string pbstrBrowseLocation
)

int ComponentSelectorDlg2(
    [InAttribute] unsigned int grfFlags, 
    [InAttribute] IVsComponentUser^ pUser, 
    [InAttribute] unsigned int cComponents, 
    [InAttribute] array<IntPtr>^ rgpcsdComponents, 
    [InAttribute] String^ lpszDlgTitle, 
    [InAttribute] String^ lpszHelpTopic, 
    [InAttribute] [OutAttribute] unsigned int% pxDlgSize, 
    [InAttribute] [OutAttribute] unsigned int% pyDlgSize, 
    [InAttribute] unsigned int cTabInitializers, 
    [InAttribute] array<VSCOMPONENTSELECTORTABINIT>^ rgcstiTabInitializers, 
    [InAttribute] [OutAttribute] Guid% pguidStartOnThisTab, 
    [InAttribute] String^ pszBrowseFilters, 
    [InAttribute] [OutAttribute] String^% pbstrBrowseLocation
)

abstract ComponentSelectorDlg2 : 
        grfFlags:uint32 * 
        pUser:IVsComponentUser * 
        cComponents:uint32 * 
        rgpcsdComponents:IntPtr[] * 
        lpszDlgTitle:string * 
        lpszHelpTopic:string * 
        pxDlgSize:uint32 byref * 
        pyDlgSize:uint32 byref * 
        cTabInitializers:uint32 * 
        rgcstiTabInitializers:VSCOMPONENTSELECTORTABINIT[] * 
        pguidStartOnThisTab:Guid byref * 
        pszBrowseFilters:string * 
        pbstrBrowseLocation:string byref -> int

function ComponentSelectorDlg2(
    grfFlags : uint, 
    pUser : IVsComponentUser, 
    cComponents : uint, 
    rgpcsdComponents : IntPtr[], 
    lpszDlgTitle : String, 
    lpszHelpTopic : String, 
    pxDlgSize : uint, 
    pyDlgSize : uint, 
    cTabInitializers : uint, 
    rgcstiTabInitializers : VSCOMPONENTSELECTORTABINIT[], 
    pguidStartOnThisTab : Guid, 
    pszBrowseFilters : String, 
    pbstrBrowseLocation : String
) : int

Parameters

grfFlags
Type: System.UInt32
[in] Component selection flags taken from the VSCOMPSELFLAGS2 enumerator.

pUser
Type: Microsoft.VisualStudio.Shell.Interop.IVsComponentUser
[in] Interface on which AddComponent will be called.

cComponents
Type: System.UInt32
[in] Number of components in the rgpcsdComponents array.

rgpcsdComponents
Type: array<System.IntPtr[]
[in] Prepopulation of Selected Components. Can be NULL. User has the ability to remove any of these components from the list.

lpszDlgTitle
Type: System.String
[in] Dialog box caption (nulla null reference (Nothing in Visual Basic) == "Select component").

lpszHelpTopic
Type: System.String
[in] F1 help topic (nulla null reference (Nothing in Visual Basic) == "VS.ComponentPicker")

pxDlgSize
Type: System.UInt32%
[in,out] 0 to use default.

pyDlgSize
Type: System.UInt32%
[in,out] 0 to use default.

cTabInitializers
Type: System.UInt32
[in] Number of tabs.

rgcstiTabInitializers
Type: array<Microsoft.VisualStudio.Shell.Interop.VSCOMPONENTSELECTORTABINIT[]
[in] Show order of tabs and their initialization info.

pguidStartOnThisTab
Type: System.Guid%
[in,out] Tab to show when the dialog starts up

pszBrowseFilters
Type: System.String
[in] List of filters to use in 'Browse...' dialog

pbstrBrowseLocation
Type: System.String%
[in,out]Directory (initial/return value) to start the 'Browse...' dialog in

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:

HRESULT IVsComponentSelectorDlg2::ComponentSelectorDlg2(
   [in] VSCOMPSELFLAGS2 grfFlags, 
   [in] IVsComponentUser *pUser, 
   [in] ULONG cComponents, 
   [in, size_is(cComponents)] PVSCOMPONENTSELECTORDATA rgpcsdComponents[], 
   [in] LPCOLESTR lpszDlgTitle, 
   [in] LPCOLESTR lpszHelpTopic, 
   [in, out] ULONG * pxDlgSize, 
   [in, out] ULONG * pyDlgSize, 
   [in] ULONG cTabInitializers, 
   [in, size_is(cTabInitializers)] VSCOMPONENTSELECTORTABINIT rgcstiTabInitializers[], 
   [in, out] GUID * pguidStartOnThisTab, 
   [in] LPCOLESTR pszBrowseFilters, 
   [in, out] BSTR *pbstrBrowseLocation
);

.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