IVsTaskItem::Document Method (String^)

 

Returns the name of the file associated with a task item.

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

int Document(
	[OutAttribute] String^% pbstrMkDocument
)

Parameters

pbstrMkDocument
Type: System::String^

[out, retval] Path to the document for this task item.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

From vsshell.idl:

HRESULT IVsTaskItem::Document(
   [out,retval] BSTR *pbstrMkDocument
);

Use this method to specify a file that is the source of a task item. To further specify the exact line and column that correspond to this task within the file, implement the Line and Column methods, respectively. Implement the NavigateTo method to open the file specified by the Document method and move the cursor to the position specified by the Line and Column methods.

Return to top
Show: