_VSRDTFLAGS _VSRDTFLAGS _VSRDTFLAGS _VSRDTFLAGS _VSRDTFLAGS _VSRDTFLAGS Enum

Definition

Specifies options for a document in the running document table (RDT).

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

public enum class _VSRDTFLAGS
public enum class _VSRDTFLAGS
enum _VSRDTFLAGS
[System.Flags]
public enum _VSRDTFLAGS
type _VSRDTFLAGS = 
Public Enum _VSRDTFLAGS
Inheritance
_VSRDTFLAGS_VSRDTFLAGS_VSRDTFLAGS_VSRDTFLAGS_VSRDTFLAGS_VSRDTFLAGS
Attributes

Fields

RDT_CanBuildFromMemory RDT_CanBuildFromMemory RDT_CanBuildFromMemory RDT_CanBuildFromMemory RDT_CanBuildFromMemory RDT_CanBuildFromMemory 32768

Indicates that a save of the document is not forced on a build.

RDT_CantSave RDT_CantSave RDT_CantSave RDT_CantSave RDT_CantSave RDT_CantSave 40

Combination of RDT_DontSave and RDT_DontSaveAs flags.

RDT_CaseSensitive RDT_CaseSensitive RDT_CaseSensitive RDT_CaseSensitive RDT_CaseSensitive RDT_CaseSensitive 128

When comparing MkDocument strings, perform a case-sensitive comparison of the strings.

RDT_DOCMASK RDT_DOCMASK RDT_DOCMASK RDT_DOCMASK RDT_DOCMASK RDT_DOCMASK -3848

Mask of the flags from RDT_DontSaveAs through RDT_DontAddToMRU. Allow __VSCREATEDOCWIN flags in doc mask.

RDT_DontAddToMRU RDT_DontAddToMRU RDT_DontAddToMRU RDT_DontAddToMRU RDT_DontAddToMRU RDT_DontAddToMRU 65536

Do not add to the list of most recently used files.

RDT_DontAutoOpen RDT_DontAutoOpen RDT_DontAutoOpen RDT_DontAutoOpen RDT_DontAutoOpen RDT_DontAutoOpen 64

Indicates that the document is not persisted in the list of documents that can be opened when the solution is re-opened. Such a document would not be opened using an editor factory, but might be opened using a wizard or special programmatic code.

RDT_DontSave RDT_DontSave RDT_DontSave RDT_DontSave RDT_DontSave RDT_DontSave 32

Any document marked with this value is not included in the list of documents shown in the Save Changes dialog box. The Save Changes dialog box is displayed when the user selects Exit from the File menu.

RDT_DontSaveAs RDT_DontSaveAs RDT_DontSaveAs RDT_DontSaveAs RDT_DontSaveAs RDT_DontSaveAs 8

Indicates that the Save As command should not be made available for this document.

RDT_EditLock RDT_EditLock RDT_EditLock RDT_EditLock RDT_EditLock RDT_EditLock 2

Places an edit lock on the document

RDT_LOCKMASK RDT_LOCKMASK RDT_LOCKMASK RDT_LOCKMASK RDT_LOCKMASK RDT_LOCKMASK 7

Mask of the RDT_NoLock, RDT_ReadLock, RDT_EditLock, and RDT_RequestUnlock flags.

RDT_NoLock RDT_NoLock RDT_NoLock RDT_NoLock RDT_NoLock RDT_NoLock 0

Indicates that no lock is placed on the document.

RDT_NonCreatable RDT_NonCreatable RDT_NonCreatable RDT_NonCreatable RDT_NonCreatable RDT_NonCreatable 16

Indicates that the document is created through some special programmatic means. For example, using a wizard. If you specify the RDT_NonCreatable flag, then the RDT_DontAutoOpen flag automatically applies to your document.

RDT_PlaceHolderDoc RDT_PlaceHolderDoc RDT_PlaceHolderDoc RDT_PlaceHolderDoc RDT_PlaceHolderDoc RDT_PlaceHolderDoc 16384

Used in the implementation of miscellaneous files. Prevents the Miscellaneous Files project from calling the CreateDocumentWindow(UInt32, String, IVsUIHierarchy, UInt32, IntPtr, IntPtr, Guid, String, Guid, IServiceProvider, String, String, Int32[], IVsWindowFrame) method on the document added to the project.

RDT_ProjSlnDocument RDT_ProjSlnDocument RDT_ProjSlnDocument RDT_ProjSlnDocument RDT_ProjSlnDocument RDT_ProjSlnDocument 8192

Set automatically by the environment when a solution or project is opened. Used to flag solution and project files in the running document table. Clients are required to set this flag in the case of nested projects.

RDT_ReadLock RDT_ReadLock RDT_ReadLock RDT_ReadLock RDT_ReadLock RDT_ReadLock 1

Places a read lock on the document.

RDT_RequestUnlock RDT_RequestUnlock RDT_RequestUnlock RDT_RequestUnlock RDT_RequestUnlock RDT_RequestUnlock 4

Requests an unlock of the document.

RDT_SAVEMASK RDT_SAVEMASK RDT_SAVEMASK RDT_SAVEMASK RDT_SAVEMASK RDT_SAVEMASK 3840

Mask of the RDT_Unlock_NoSave, RDT_Unlock_SaveIfDirty, and RDT_Unlock_PromptSave flags.

RDT_Unlock_NoSave RDT_Unlock_NoSave RDT_Unlock_NoSave RDT_Unlock_NoSave RDT_Unlock_NoSave RDT_Unlock_NoSave 256

Used by UnlockDocument(UInt32, UInt32). Release the edit lock and do not save.

RDT_Unlock_PromptSave RDT_Unlock_PromptSave RDT_Unlock_PromptSave RDT_Unlock_PromptSave RDT_Unlock_PromptSave RDT_Unlock_PromptSave 1024

Used by the UnlockDocument(UInt32, UInt32) method. Release the edit lock and prompt the user to save the file.

RDT_Unlock_SaveIfDirty RDT_Unlock_SaveIfDirty RDT_Unlock_SaveIfDirty RDT_Unlock_SaveIfDirty RDT_Unlock_SaveIfDirty RDT_Unlock_SaveIfDirty 512

Used by the UnlockDocument(UInt32, UInt32) method. Release the edit lock and save the file if it is dirty.

RDT_VirtualDocument RDT_VirtualDocument RDT_VirtualDocument RDT_VirtualDocument RDT_VirtualDocument RDT_VirtualDocument 4096

Exclude this document from being considered in the documents collection for the automation model.

Remarks

COM Signature

From vsshell.idl:

typedef enum __VSRDTFLAGS {  
    RDT_NoLock             = 0x00000000,  
    RDT_ReadLock           = 0x00000001,  
    RDT_EditLock           = 0x00000002,  
    RDT_RequestUnlock      = 0x00000004,  
    RDT_LOCKMASK           = 0x00000007,  

    RDT_DontSaveAs         = 0x00000008,  
    RDT_NonCreatable       = 0x00000010,  
    RDT_DontSave           = 0x00000020,  
    RDT_DontAutoOpen       = 0x00000040,  
    RDT_CaseSensitive      = 0x00000080,  
    RDT_CantSave           = RDT_DontSave | RDT_DontSaveAs,  
    RDT_VirtualDocument    = 0x00001000,  
    RDT_ProjSlnDocument    = 0x00002000,  
    RDT_PlaceHolderDoc     = 0x00004000,  
    RDT_CanBuildFromMemory = 0x00008000,  
    RDT_DontAddToMRU       = 0x00010000,  
    RDT_DOCMASK            = 0xFFFFF0F8,  

    RDT_Unlock_NoSave      = 0x00000100,  
    RDT_Unlock_SaveIfDirty = 0x00000200,  
    RDT_Unlock_PromptSave  = 0x00000400,  
    RDT_SAVEMASK           = 0x00000F00,  
} _VSRDTFLAGS;  
typedef DWORD VSRDTFLAGS;  

This enumeration is used by a number of methods in the IVsRunningDocumentTable, IVsRunningDocTableEvents, IVsRunningDocTableEvents2, and the IVsRunningDocTableEvents3 interfaces.

These flags are also used in combination with flags from the __VSOSPEFLAGS enumeration when passed to the OpenSpecificEditor method.

The flags masked by the RDT_DOCMASK value can also be combined with flags from the __VSCREATEDOCWIN enumeration when creating a document window in calls to the CreateDocumentWindow, AddDocument (IVsExternalFilesManager interface), AddDocument (IVsExternalFilesManager2 interface), and AddDocumentEx methods.

Applies to