IVsTaskItem.IsReadOnly Method

Article
03/06/2013

Determines whether a specified task field is set to read-only status.

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

Syntax

'Declaration
Function IsReadOnly ( _
    field As VSTASKFIELD, _
    <OutAttribute> ByRef pfReadOnly As Integer _
) As Integer

int IsReadOnly(
    VSTASKFIELD field,
    out int pfReadOnly
)

int IsReadOnly(
    [InAttribute] VSTASKFIELD field, 
    [OutAttribute] int% pfReadOnly
)

abstract IsReadOnly : 
        field:VSTASKFIELD * 
        pfReadOnly:int byref -> int

function IsReadOnly(
    field : VSTASKFIELD, 
    pfReadOnly : int
) : int

Parameters

field
Type: Microsoft.VisualStudio.Shell.Interop.VSTASKFIELD
[in] Task field of which to check read-only status. For a list of field values, see VSTASKFIELD.

pfReadOnly
Type: System.Int32%
[out, retval] If true, then the task field is read-only. If false, then the task field can be edited by the user.

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

HRESULT IVsTaskItem::IsReadOnly(
   [in] VSTASKFIELD field,
   [out, retval]BOOL *pfReadOnly
);

If the pfReadOnly parameter is set to false, then the user can edit the specified field and the task list uses the appropriate put method to update the task's information for that field. For example, if the priority field is set to read-write, then the task list uses the put_Priority method to set this field.

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