IVsUIShell.UpdateDocDataIsDirtyFeedback Method

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

'Declaration
Function UpdateDocDataIsDirtyFeedback ( _
    docCookie As UInteger, _
    fDirty As Integer _
) As Integer
'Usage
Dim instance As IVsUIShell
Dim docCookie As UInteger
Dim fDirty As Integer
Dim returnValue As Integer

returnValue = instance.UpdateDocDataIsDirtyFeedback(docCookie, _
    fDirty)

int UpdateDocDataIsDirtyFeedback(
    uint docCookie,
    int fDirty
)

int UpdateDocDataIsDirtyFeedback(
    [InAttribute] unsigned int docCookie, 
    [InAttribute] int fDirty
)

abstract UpdateDocDataIsDirtyFeedback : 
        docCookie:uint32 * 
        fDirty:int -> int 

function UpdateDocDataIsDirtyFeedback(
    docCookie : uint, 
    fDirty : int
) : int

Parameters

  • docCookie
    Type: System.UInt32
    [in] An abstract value representing the document in the Running Document Table.
  • fDirty
    Type: System.Int32
    [in] true (if when called) indicates that the "*" should be added to the window title. false indicates that the "*" should be removed.

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:

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.

.NET Framework Security

See Also

Reference

IVsUIShell Interface

IVsUIShell Members

Microsoft.VisualStudio.Shell.Interop Namespace

  • Last updated on