IVsUserContext.SetDirty Method

Article
02/04/2013

Flags the context or subcontext bag for update.

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

Syntax

'Declaration
Function SetDirty ( _
    fDirty As Integer _
) As Integer

int SetDirty(
    int fDirty
)

int SetDirty(
    [InAttribute] int fDirty
)

abstract SetDirty : 
        fDirty:int -> int

function SetDirty(
    fDirty : int
) : int

Parameters

fDirty
Type: System.Int32
[in] If true, then clients are informed that the user context has changed. If false, then clients are not informed that the user context has not changed.

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::SetDirty(
   [in] BOOL fDirty
);

Use the IsDirty method to determine whether the user context has changed and the IVsUserContext::SetDirty method to flag that the contents of the context bag have changed.

Note IVsUserContext.SetDirty is automatically called whenever attributes and keywords are added or removed from the context or subcontext bag.

.NET Framework Security

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.

Share via