IVsUserContext.IsDirty Method

Article
04/22/2008

Determines whether the user context has changed in the context or subcontext bag.

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

Syntax

'Déclaration
Function IsDirty ( _
    <OutAttribute> ByRef pfDirty As Integer _
) As Integer
'Utilisation
Dim instance As IVsUserContext
Dim pfDirty As Integer
Dim returnValue As Integer

returnValue = instance.IsDirty(pfDirty)

int IsDirty(
    out int pfDirty
)

int IsDirty(
    [OutAttribute] int% pfDirty
)

function IsDirty(
    pfDirty : int
) : int

Parameters

pfDirty
Type: System.Int32%

[out, retval] If true, then the user context has changed. If false, then the user context is unchanged.

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 context.idl:

HRESULT IVsUserContext::IsDirty(
   [out, retval] BOOL * pfDirty
);

Use the IVsUserContext.IsDirty method to determine whether the user context has changed and the SetDirty method to flag that the contents of the context bag have changed. At idle time, the Dynamic Help window updates its context from all context bags in the active selection that are identified as having changed.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via