IVsTaskItem2.get_Checked Method

Article
03/06/2013

Determines whether the task item's check box is currently selected or cleared.

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

Syntax

'Declaration
Function get_Checked ( _
    <OutAttribute> ByRef pfChecked As Integer _
) As Integer

int get_Checked(
    out int pfChecked
)

int get_Checked(
    [OutAttribute] int% pfChecked
)

abstract get_Checked : 
        pfChecked:int byref -> int

function get_Checked(
    pfChecked : int
) : int

Parameters

pfChecked
Type: System.Int32%
[out, retval] If true, then the check box for the task item is selected. If false, then the check box is cleared.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IVsTaskItem.get_Checked(Int32%)

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsTaskItem2::get_Checked(
   [out,retval]BOOL *pfChecked
);

If pfChecked returns as true, the text in the task list is grey, indicating the task has been completed. If pfChecked returns as false the task list text is not grey and indicates the task has not been completed.

.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