IVsUIShellOpenDocument3.GetProvisionalViewingStatusForFile Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.11.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.11.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.11.0.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.

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

public:
 System::UInt32 GetProvisionalViewingStatusForFile(System::String ^ filename, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ hierarchy, System::UInt32 itemid, Guid % logicalView);

public uint GetProvisionalViewingStatusForFile (string filename, Microsoft.VisualStudio.Shell.Interop.IVsHierarchy hierarchy, uint itemid, ref Guid logicalView);

abstract member GetProvisionalViewingStatusForFile : string * Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * Guid -> uint32

Public Function GetProvisionalViewingStatusForFile (filename As String, hierarchy As IVsHierarchy, itemid As UInteger, ByRef logicalView As Guid) As UInteger

Parameters

filename: String

[in] The name of the file.

hierarchy: IVsHierarchy

[in] The hierarchy of the item.

itemid: UInt32

[in] The item identifier of the item.

logicalView: Guid

[in] The logical view to query.

Returns

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.

Applies to