Share via


IVsUIShellOpenDocument3.GetProvisionalViewingStatusForFile Method

Retrieves the provisional viewing status for the highest ranked editor associated with the file.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assemblies:   Microsoft.VisualStudio.Shell.Interop.11.0 (in Microsoft.VisualStudio.Shell.Interop.11.0.dll)
  Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
Function GetProvisionalViewingStatusForFile ( _
    filename As String, _
    hierarchy As IVsHierarchy, _
    itemid As UInteger, _
    ByRef logicalView As Guid _
) As UInteger
uint GetProvisionalViewingStatusForFile(
    string filename,
    IVsHierarchy hierarchy,
    uint itemid,
    ref Guid logicalView
)
unsigned int GetProvisionalViewingStatusForFile(
    [InAttribute] String^ filename, 
    [InAttribute] IVsHierarchy^ hierarchy, 
    [InAttribute] unsigned int itemid, 
    [InAttribute] Guid% logicalView
)
abstract GetProvisionalViewingStatusForFile : 
        filename:string * 
        hierarchy:IVsHierarchy * 
        itemid:uint32 * 
        logicalView:Guid byref -> uint32
function GetProvisionalViewingStatusForFile(
    filename : String, 
    hierarchy : IVsHierarchy, 
    itemid : uint, 
    logicalView : Guid
) : uint

Parameters

  • filename
    Type: String

    [in] The name of the file.

  • itemid
    Type: UInt32

    [in] The item identifier of the item.

  • logicalView
    Type: Guid%

    [in] The logical view to query.

Return Value

Type: UInt32
The provisional viewing status as a member of __VSPROVISIONALVIEWINGSTATUS. The default provisional viewing status is PVS_Disabled, but can be modified by the editor's "CommonPhysicalViewAttributes" registry value and the values under its "PhysicalViewAttributes" registry subkey.

Remarks

The physical view attributes – which declare if and how the physical view supports provisional viewing (that is, previewing) – are properties of the editor. In addition to physical view attributes, editors also declare what file types they can edit (for example, *.cs, *.xml, and so on) and the relative “rank” of the editor. Multiple editors can declare that they support the same file type and the shell then chooses the one with the highest rank to open the file.

.NET Framework Security

See Also

Reference

IVsUIShellOpenDocument3 Interface

Microsoft.VisualStudio.Shell.Interop Namespace