IVsComponentSelectorDlg.ComponentSelectorDlg Method

Article
07/12/2014

Used by a package to provide a dialog with which the user can add components to the specified project.

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

Syntax

'Declaration
Function ComponentSelectorDlg ( _
    grfFlags As UInteger, _
    pUser As IVsComponentUser, _
    lpszDlgTitle As String, _
    lpszHelpTopic As String, _
    ByRef rguidShowOnlyThisTab As Guid, _
    ByRef rguidStartOnThisTab As Guid, _
    pszMachineName As String, _
    cTabInitializers As UInteger, _
    prgcstiTabInitializers As VSCOMPONENTSELECTORTABINIT(), _
    pszBrowseFilters As String, _
    <OutAttribute> ByRef pbstrBrowseLocation As String _
) As Integer

int ComponentSelectorDlg(
    uint grfFlags,
    IVsComponentUser pUser,
    string lpszDlgTitle,
    string lpszHelpTopic,
    ref Guid rguidShowOnlyThisTab,
    ref Guid rguidStartOnThisTab,
    string pszMachineName,
    uint cTabInitializers,
    VSCOMPONENTSELECTORTABINIT[] prgcstiTabInitializers,
    string pszBrowseFilters,
    out string pbstrBrowseLocation
)

int ComponentSelectorDlg(
    [InAttribute] unsigned int grfFlags, 
    [InAttribute] IVsComponentUser^ pUser, 
    [InAttribute] String^ lpszDlgTitle, 
    [InAttribute] String^ lpszHelpTopic, 
    [InAttribute] Guid% rguidShowOnlyThisTab, 
    [InAttribute] Guid% rguidStartOnThisTab, 
    [InAttribute] String^ pszMachineName, 
    [InAttribute] unsigned int cTabInitializers, 
    [InAttribute] array<VSCOMPONENTSELECTORTABINIT>^ prgcstiTabInitializers, 
    [InAttribute] String^ pszBrowseFilters, 
    [InAttribute] [OutAttribute] String^% pbstrBrowseLocation
)

abstract ComponentSelectorDlg : 
        grfFlags:uint32 * 
        pUser:IVsComponentUser * 
        lpszDlgTitle:string * 
        lpszHelpTopic:string * 
        rguidShowOnlyThisTab:Guid byref * 
        rguidStartOnThisTab:Guid byref * 
        pszMachineName:string * 
        cTabInitializers:uint32 * 
        prgcstiTabInitializers:VSCOMPONENTSELECTORTABINIT[] * 
        pszBrowseFilters:string * 
        pbstrBrowseLocation:string byref -> int

function ComponentSelectorDlg(
    grfFlags : uint, 
    pUser : IVsComponentUser, 
    lpszDlgTitle : String, 
    lpszHelpTopic : String, 
    rguidShowOnlyThisTab : Guid, 
    rguidStartOnThisTab : Guid, 
    pszMachineName : String, 
    cTabInitializers : uint, 
    prgcstiTabInitializers : VSCOMPONENTSELECTORTABINIT[], 
    pszBrowseFilters : String, 
    pbstrBrowseLocation : String
) : int

Parameters

grfFlags
Type: System.UInt32

[in] VSCOMSEL_* flags. For more information on VSCOMSEL_, see __VSCOMPSELFLAGS.

pUser
Type: Microsoft.VisualStudio.Shell.Interop.IVsComponentUser

[in] Interface on which AddComponent will be called.

lpszDlgTitle
Type: System.String

[in] dialog caption (nulla null reference (Nothing in Visual Basic) == "Component Selector").

lpszHelpTopic
Type: System.String

[in] F1 help topic (nulla null reference (Nothing in Visual Basic) == "VS.ComponentPicker").

rguidShowOnlyThisTab
Type: System.Guid%

[in] tab to show exclusively.

rguidStartOnThisTab
Type: System.Guid%

[in] tab to show when the dialog starts up.

pszMachineName
Type: System.String

[in] Pointer to a null terminated string containing the machine name. Enumerate COM components on this machine.

cTabInitializers
Type: System.UInt32

[in] Number of tab initialization structs in prgcstiTabInitializers.

prgcstiTabInitializers
Type: array<Microsoft.VisualStudio.Shell.Interop.VSCOMPONENTSELECTORTABINIT[]

[in] Specifies the tab initialization information.

pszBrowseFilters
Type: System.String

[in] Pointer to a null terminated string containing the browse filters.

pbstrBrowseLocation
Type: System.String%

[in, out] On input, xxxx. On output, pointer to a string containing the browse location. List of filters to use in 'Browse...' dialog box. Directory (initial/return value) to start the 'Browse...' dialog box 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 vsshell.idl:

HRESULT IVsComponentSelectorDlg::ComponentSelectorDlg(
   [in] VSCOMPSELFLAGS grfFlags,
   [in] IVsComponentUser *pUser,
   [in] LPCOLESTR lpszDlgTitle,
   [in] LPCOLESTR lpszHelpTopic,
   [in] REFGUID rguidShowOnlyThisTab,
   [in] REFGUID rguidStartOnThisTab,
   [in] LPCOLESTR pszMachineName,
   [in] ULONG cTabInitializers,
   [in] VSCOMPONENTSELECTORTABINIT *prgcstiTabInitializers,
   [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