Determines whether the specified document is open.
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell (in Microsoft.VisualStudio.Shell.dll)
Syntax
'Declaration
Public Shared Function IsDocumentOpen ( _
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 Boolean
'Usage
Dim provider As IServiceProvider
Dim fullPath As String
Dim logicalView As Guid
Dim hierarchy As IVsUIHierarchy
Dim itemID As UInteger
Dim windowFrame As IVsWindowFrame
Dim returnValue As Boolean
returnValue = VsShellUtilities.IsDocumentOpen(provider, _
fullPath, logicalView, hierarchy, _
itemID, windowFrame)
public static bool IsDocumentOpen(
IServiceProvider provider,
string fullPath,
Guid logicalView,
out IVsUIHierarchy hierarchy,
out uint itemID,
out IVsWindowFrame windowFrame
)
public:
static bool IsDocumentOpen(
IServiceProvider^ provider,
String^ fullPath,
Guid logicalView,
[OutAttribute] IVsUIHierarchy^% hierarchy,
[OutAttribute] unsigned int% itemID,
[OutAttribute] IVsWindowFrame^% windowFrame
)
public static function IsDocumentOpen(
provider : IServiceProvider,
fullPath : String,
logicalView : Guid,
hierarchy : IVsUIHierarchy,
itemID : uint,
windowFrame : IVsWindowFrame
) : boolean
Parameters
provider
Type: System.IServiceProvider
fullPath
Type: System.StringThe full path to the document.
logicalView
Type: System.GuidThe GUID of the logical view.
hierarchy
Type: Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy%[out] Returns the IVsUIHierarchy interface of the project that contains the document.
itemID
Type: System.UInt32%[out] Returns the item ID of the document.
windowFrame
Type: Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame%[out] Returns the IVsWindowFrame in which the document is open.
Return Value
Type: System.Boolean
true if the document is open in the given logical view. If logicalView is Guid.Empty, then this method returns true if any view is open; otherwise, false.
.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.