IVsRunningDocumentTable::ModifyDocumentFlags Method (UInt32, UInt32, Int32)

Visual Studio 2015

Modifies the RDT document flags for a registered document.

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

Syntax

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

docCookie: Type: System::UInt32
[in] Unique value representing the document.

grfFlags: Type: System::UInt32
[in] Valid document flags. See Remarks for valid modifications. See _VSRDTFLAGS

fSet: Type: System::Int32
[in]. Flag indicating that the document flag has been set.

Type: System::Int32

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

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:

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