IVsUIShell::UpdateDocDataIsDirtyFeedback Method (UInt32, Int32)

Visual Studio 2015

Makes it possible for a document data object to synchronously inform the environment when their document must be changed.

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

Syntax

C++

int UpdateDocDataIsDirtyFeedback(
	unsigned int docCookie,
	int fDirty
)

Parameters

docCookie: Type: System::UInt32
[in] An abstract value representing the document in the Running Document Table.

fDirty: Type: System::Int32
The value of this parameter is ignored. The document's IsItemDirty method is called to determine the document's dirty state.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsUIShell::UpdateDocDataIsDirtyFeedback(
   [in] VSCOOKIE docCookie,
   [in] BOOL fDirty
);

This method makes the environment add the "*" to the window title. The "*" is part of the document window caption that is added automatically by the environment. Document data objects should call QueryService for SID_SVsUIShell to access this method.