IVsUIShell.UpdateDocDataIsDirtyFeedback(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.

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

public:
 int UpdateDocDataIsDirtyFeedback(System::UInt32 docCookie, int fDirty);

public:
 int UpdateDocDataIsDirtyFeedback(unsigned int docCookie, int fDirty);

int UpdateDocDataIsDirtyFeedback(unsigned int docCookie, int fDirty);

public int UpdateDocDataIsDirtyFeedback (uint docCookie, int fDirty);

abstract member UpdateDocDataIsDirtyFeedback : uint32 * int -> int

Public Function UpdateDocDataIsDirtyFeedback (docCookie As UInteger, fDirty As Integer) As Integer

Parameters

docCookie: UInt32

[in] An abstract value representing the document in the Running Document Table.

fDirty: Int32

The value of this parameter is ignored. The document's IsItemDirty(UInt32, IntPtr, Int32) method is called to determine the document's dirty state.

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 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.

Applies to