IVsTaskItem.Document Method

Article
05/06/2010

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)

Syntax

'Déclaration
Function Document ( _
    <OutAttribute> ByRef pbstrMkDocument As String _
) As Integer
'Utilisation
Dim instance As IVsTaskItem
Dim pbstrMkDocument As String
Dim returnValue As Integer

returnValue = instance.Document(pbstrMkDocument)

int Document(
    out string pbstrMkDocument
)

int Document(
    [OutAttribute] String^% pbstrMkDocument
)

abstract Document : 
        pbstrMkDocument:string byref -> int

function Document(
    pbstrMkDocument : String
) : int

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.

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.

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

Partager via