IVsRunningDocumentTable.ModifyDocumentFlags(UInt32, UInt32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Modifies the RDT document flags for a registered document.

public:
 int ModifyDocumentFlags(System::UInt32 docCookie, System::UInt32 grfFlags, int fSet);

public:
 int ModifyDocumentFlags(unsigned int docCookie, unsigned int grfFlags, int fSet);

int ModifyDocumentFlags(unsigned int docCookie, unsigned int grfFlags, int fSet);

public int ModifyDocumentFlags (uint docCookie, uint grfFlags, int fSet);

abstract member ModifyDocumentFlags : uint32 * uint32 * int -> int

Public Function ModifyDocumentFlags (docCookie As UInteger, grfFlags As UInteger, fSet As Integer) As Integer

Parameters

docCookie: UInt32

[in] Unique value representing the document.

grfFlags: UInt32

[in] Valid document flags. See Remarks for valid modifications. See _VSRDTFLAGS

fSet: Int32

[in]. Flag indicating that the document flag has been set.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocumentTable::ModifyDocumentFlags(  
   VSCOOKIE   docCookie,  
   VSRDTFLAGS grfFlags,  
   BOOL       fSet  
);

This method is used to modify the RDT document flags for a registered document. Currently the only valid flags to modify are:

Flags	Modification Allowed
RDT_DontSaveAs	Set only (`fSet` must be `true`)
RDT_DontSave	Set only
RDT_CantSave	Set only
RDT_DontAddToMRU	Set only

The docCookie parameter is the same value that is returned from the FindAndLockDocument or RegisterAndLockDocument methods.

Applies to