IVsTaskItem.Document(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int Document([Runtime::InteropServices::Out] System::String ^ % pbstrMkDocument);

int Document([Runtime::InteropServices::Out] std::wstring const & & pbstrMkDocument);

public int Document (out string pbstrMkDocument);

abstract member Document : string -> int

Public Function Document (ByRef pbstrMkDocument As String) As Integer

Parameters

pbstrMkDocument: String

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

Returns

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

Applies to

Partager via