IVsTaskProvider3.OnEndTaskEdit Method

Article
03/06/2013

Called when the user finishes editing a task in-place. fCommitChanges indicates whether the user chose to commit the changes or discard them. This method may set *pfAllowChanges to FALSE to disallow the user from exiting edit mode. If fCommitChanges is TRUE, the changes will have already been persisted down to the task item.

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

Syntax

'Declaration
Function OnEndTaskEdit ( _
    pItem As IVsTaskItem, _
    fCommitChanges As Integer, _
    <OutAttribute> ByRef pfAllowChanges As Integer _
) As Integer

int OnEndTaskEdit(
    IVsTaskItem pItem,
    int fCommitChanges,
    out int pfAllowChanges
)

int OnEndTaskEdit(
    [InAttribute] IVsTaskItem^ pItem, 
    [InAttribute] int fCommitChanges, 
    [OutAttribute] int% pfAllowChanges
)

abstract OnEndTaskEdit : 
        pItem:IVsTaskItem * 
        fCommitChanges:int * 
        pfAllowChanges:int byref -> int

function OnEndTaskEdit(
    pItem : IVsTaskItem, 
    fCommitChanges : int, 
    pfAllowChanges : int
) : int

Parameters

pItem
Type: Microsoft.VisualStudio.Shell.Interop.IVsTaskItem
[in] A pointer to an object of type IVsTaskItem.

fCommitChanges
Type: System.Int32
[in] A Boolean value set to TRUE if the user chooses to commit the changes.

pfAllowChanges
Type: System.Int32%
[out] A Boolean value set to FALSE to disallow the user from exiting edit mode, or to TRUE if the changes were already persisted down to the task item.

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

HRESULT IVsTaskProvider3::OnEndTaskEdit(
   [in] IVsTaskItem* pItem, 
   [in] BOOL fCommitChanges, 
   [out] BOOL* pfAllowChanges
);

.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