IVsTaskItem2::IsReadOnly Method (VSTASKFIELD, Int32)

Visual Studio 2015

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

C++

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

Parameters

field: Type: Microsoft.VisualStudio.Shell.Interop::VSTASKFIELD
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.

Implements

IVsTaskItem::IsReadOnly(VSTASKFIELD, Int32)

Remarks

COM Signature

From vsshell.idl:

C++

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.