__VSRDTSAVEOPTIONS Enumeration

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Public Enumeration __VSRDTSAVEOPTIONS
public enum __VSRDTSAVEOPTIONS
public enum class __VSRDTSAVEOPTIONS
type __VSRDTSAVEOPTIONS
public enum __VSRDTSAVEOPTIONS

Members

Member name Description
RDTSAVEOPT_SaveIfDirty Saves only if changes have been made. (This is the default.)
RDTSAVEOPT_PromptSave Prompts user to save the document.
RDTSAVEOPT_ForceSave Forces a save even if not dirty.
RDTSAVEOPT_SaveNoChildren Saves only the root of the hierarchy passed in; does not include its children.
RDTSAVEOPT_SaveOnlyChildren Saves only children of the hierarchy passed in; does not include the hierarchy itself.
RDTSAVEOPT_ActivateDocOnErr Activates the editor window of a document if it generates an error on save.
RDTSAVEOPT_DocClose Indicates that the save is a result of a document close.
RDTSAVEOPT_Reserved Reserved flag, do not use.

Remarks

COM Signature

From vsshell.idl:

enum __VSRDTSAVEOPTIONS {
    RDTSAVEOPT_SaveIfDirty      = 0x00000000,
    RDTSAVEOPT_PromptSave       = 0x00000001,
    RDTSAVEOPT_ForceSave        = 0x00000002,
    RDTSAVEOPT_SaveNoChildren   = 0x00000004,
    RDTSAVEOPT_SaveOnlyChildren = 0x00000008,
    RDTSAVEOPT_ActivateDocOnErr = 0x00000010,
    RDTSAVEOPT_DocClose         = 0x00010000,
    RDTSAVEOPT_Reserved         = 0xFFFF0000
};
typedef DWORD VSRDTSAVEOPTIONS;

These flags are passed to the SaveDocuments method. These flags are also specified in the VSSAVETREEITEM structure.

These flags can be combined with the flags from the __FRAMECLOSE enumeration when passed to the SaveDocuments method.

For additional RDTSAVEOPT_ flags, see the __VSRDTSAVEOPTIONS2 enumeration.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace