IVsUIShell2.GetDirectoryViaBrowseDlgEx Method

Article
02/04/2013

Brings up the Browse dialog box to obtain a directory name (possibly in a namespace extension).

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

Syntax

'Declaration
Function GetDirectoryViaBrowseDlgEx ( _
    <OutAttribute> pBrowse As VSBROWSEINFOW(), _
    pszHelpTopic As String, _
    pszOpenButtonLabel As String, _
    pszCeilingDir As String, _
    pNSEBrowseInfo As VSNSEBROWSEINFOW() _
) As Integer

int GetDirectoryViaBrowseDlgEx(
    VSBROWSEINFOW[] pBrowse,
    string pszHelpTopic,
    string pszOpenButtonLabel,
    string pszCeilingDir,
    VSNSEBROWSEINFOW[] pNSEBrowseInfo
)

int GetDirectoryViaBrowseDlgEx(
    [InAttribute] [OutAttribute] array<VSBROWSEINFOW>^ pBrowse, 
    [InAttribute] String^ pszHelpTopic, 
    [InAttribute] String^ pszOpenButtonLabel, 
    [InAttribute] String^ pszCeilingDir, 
    [InAttribute] array<VSNSEBROWSEINFOW>^ pNSEBrowseInfo
)

abstract GetDirectoryViaBrowseDlgEx : 
        pBrowse:VSBROWSEINFOW[] byref * 
        pszHelpTopic:string * 
        pszOpenButtonLabel:string * 
        pszCeilingDir:string * 
        pNSEBrowseInfo:VSNSEBROWSEINFOW[] -> int

function GetDirectoryViaBrowseDlgEx(
    pBrowse : VSBROWSEINFOW[], 
    pszHelpTopic : String, 
    pszOpenButtonLabel : String, 
    pszCeilingDir : String, 
    pNSEBrowseInfo : VSNSEBROWSEINFOW[]
) : int

Parameters

pBrowse
Type: array<Microsoft.VisualStudio.Shell.Interop.VSBROWSEINFOW[]
[in, out] A VSBROWSEINFOW structure that contains information used to initialize the dialog box. When this method returns, this structure contains information about the directory location selected by the user. These values are defined in VSBROWSEINFOW structure.

pszHelpTopic
Type: System.String
[in] A string containing the help topic. This overrides the dwHelpTopic parameter in VSBROWSEINFOW structure.

pszOpenButtonLabel
Type: System.String
[in] Caption text for the Open button.

pszCeilingDir
Type: System.String
[in] Limit browsing to below this location.

pNSEBrowseInfo
Type: array<Microsoft.VisualStudio.Shell.Interop.VSNSEBROWSEINFOW[]
[in] Optional. Namespace extension information .For a listing of the structure parameters, see the VSNSEBROWSEINFOW structure.

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 IVsUIShell2::GetDirectoryViaBrowseDlgEx(
   [in,out] VSBROWSEINFOW     *pBrowse,
   [in]     LPCOLESTR          pszHelpTopic,
   [in]     LPCOLESTR          pszOpenButtonLabel,
   [in]     LPCOLESTR          pszCeilingDir,
   [in]     VSNSEBROWSEINFOW  *pNSEBrowseInfo
);

.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.