VsShellUtilities.TryOpenDocument Method

Tries to open a document using the appropriate project.

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

Syntax

'Declaration
Public Shared Function TryOpenDocument ( _
    provider As IServiceProvider, _
    fullPath As String, _
    logicalView As Guid, _
    <OutAttribute> ByRef hierarchy As IVsUIHierarchy, _
    <OutAttribute> ByRef itemID As UInteger, _
    <OutAttribute> ByRef windowFrame As IVsWindowFrame _
) As Integer

public static int TryOpenDocument(
    IServiceProvider provider,
    string fullPath,
    Guid logicalView,
    out IVsUIHierarchy hierarchy,
    out uint itemID,
    out IVsWindowFrame windowFrame
)

public:
static int TryOpenDocument(
    IServiceProvider^ provider, 
    String^ fullPath, 
    Guid logicalView, 
    [OutAttribute] IVsUIHierarchy^% hierarchy, 
    [OutAttribute] unsigned int% itemID, 
    [OutAttribute] IVsWindowFrame^% windowFrame
)

static member TryOpenDocument : 
        provider:IServiceProvider * 
        fullPath:string * 
        logicalView:Guid * 
        hierarchy:IVsUIHierarchy byref * 
        itemID:uint32 byref * 
        windowFrame:IVsWindowFrame byref -> int

public static function TryOpenDocument(
    provider : IServiceProvider, 
    fullPath : String, 
    logicalView : Guid, 
    hierarchy : IVsUIHierarchy, 
    itemID : uint, 
    windowFrame : IVsWindowFrame
) : int

Parameters

• provider
  Type: IServiceProvider

  The service provider.

• fullPath
  Type: String

  The full path to the document.

• logicalView
  Type: Guid

  The GUID of the logical view.

• hierarchy
  Type: Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy%

  The T[:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy] interface of the project that contains the document to open.

• itemID
  Type: UInt32%

  The hierarchy item identifier of the document in the project.

• windowFrame
  Type: Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame%

  Te window frame that is mapped to the document.

Return Value

Type: Int32
VsConstants.S_OK if successful, otherwise a failure code.

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

See Also

Reference

VsShellUtilities Class

Microsoft.VisualStudio.Shell Namespace