IVsUIShellOpenDocument.GetFirstDefaultPreviewer(String, Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Returns the .exe file path of the first default web browser.

public:
 int GetFirstDefaultPreviewer([Runtime::InteropServices::Out] System::String ^ % pbstrDefBrowserPath, [Runtime::InteropServices::Out] int % pfIsInternalBrowser, [Runtime::InteropServices::Out] int % pfIsSystemBrowser);

int GetFirstDefaultPreviewer([Runtime::InteropServices::Out] std::wstring const & & pbstrDefBrowserPath, [Runtime::InteropServices::Out] int & pfIsInternalBrowser, [Runtime::InteropServices::Out] int & pfIsSystemBrowser);

public int GetFirstDefaultPreviewer (out string pbstrDefBrowserPath, out int pfIsInternalBrowser, out int pfIsSystemBrowser);

abstract member GetFirstDefaultPreviewer : string * int * int -> int

Public Function GetFirstDefaultPreviewer (ByRef pbstrDefBrowserPath As String, ByRef pfIsInternalBrowser As Integer, ByRef pfIsSystemBrowser As Integer) As Integer

Parameters

pbstrDefBrowserPath: String

[out] Pointer to the full path to the default browser.

pfIsInternalBrowser: Int32

[out] true if the default browser is internal.

pfIsSystemBrowser: Int32

[out] true if the default browser is the system browser.

Returns

Int32

Returns S_OK if a default previewer is defined. Returns S_FALSE if there are no default previewers.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsUIShellOpenDocument::GetFirstDefaultPreviewer(  
   [out] BSTR *pbstrDefBrowserPath,  
   [out] BOOL *pfIsInternalBrowser,  
   [out] BOOL *pfIsSystemBrowser  
);

This method returns the same browser that would have been launched if OSP_LaunchSingleBrowser were passed to OpenStandardPreviewer. If it is the internal browser, pbstrDefBrowserPath is null, *pfIsInternalBrowser is true, and the function returns S_OK.

Applies to