IVsUserContext.SetDirty(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.

Flags the context or subcontext bag for update.

public:
 int SetDirty(int fDirty);

public:
 int SetDirty(int fDirty);

int SetDirty(int fDirty);

public int SetDirty (int fDirty);

abstract member SetDirty : int -> int

Public Function SetDirty (fDirty As Integer) As Integer

Parameters

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

Returns

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.

Applies to