_VSRDTFLAGS Enumeration
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.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
<FlagsAttribute> _
Public Enumeration _VSRDTFLAGS
'Usage
Dim instance As _VSRDTFLAGS
[FlagsAttribute]
public enum _VSRDTFLAGS
[FlagsAttribute]
public enum class _VSRDTFLAGS
public enum _VSRDTFLAGS
Members
| Member name | Description | |
|---|---|---|
| RDT_NoLock | Indicates that no lock is placed on the document. | |
| RDT_ReadLock | Places a read lock on the document. | |
| RDT_EditLock | Places an edit lock on the document | |
| RDT_RequestUnlock | Requests an unlock of the document. | |
| RDT_LOCKMASK | Mask of the RDT_NoLock, RDT_ReadLock, RDT_EditLock, and RDT_RequestUnlock flags. | |
| RDT_DontSaveAs | Indicates that the SaveAs command should not be made available for this document. | |
| RDT_NonCreatable | 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_DontSave | Any document marked with this value is not included in the list of documents shown in the SaveChanges dialog box. The Save Changes dialog box is displayed when the user selects Exit from the File menu. | |
| RDT_DontAutoOpen | 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_CaseSensitive | When comparing MkDocument strings, perform a case-sensitive comparison of the strings. | |
| RDT_CantSave | Combination of RDT_DontSave and RDT_DontSaveAs flags. | |
| RDT_VirtualDocument | Exclude this document from being considered in the documents collection for the automation model. | |
| RDT_ProjSlnDocument | 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_PlaceHolderDoc | Used in the implementation of miscellaneous files. Prevents the Miscellaneous Files project from calling the CreateDocumentWindow method on the document added to the project. | |
| RDT_CanBuildFromMemory | Indicates that a save of the document is not forced on a build. | |
| RDT_DontAddToMRU | Do not add to the list of most recently used files. | |
| RDT_DOCMASK | Mask of the flags from RDT_DontSaveAs through RDT_DontAddToMRU. Allow __VSCREATEDOCWIN flags in doc mask. | |
| RDT_Unlock_NoSave | Used by UnlockDocument. Release the edit lock and do not save. | |
| RDT_Unlock_SaveIfDirty | Used by the UnlockDocument method. Release the edit lock and save the file if it is dirty. | |
| RDT_Unlock_PromptSave | Used by the UnlockDocument method. Release the edit lock and prompt the user to save the file. | |
| RDT_SAVEMASK | Mask of the RDT_Unlock_NoSave, RDT_Unlock_SaveIfDirty, and RDT_Unlock_PromptSave flags. |
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.