IVsCodeDefViewContext.GetFileName Method

Article
03/06/2013

Retrieves the file for an item based on its index in a list of context items.

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

Syntax

'Declaration
Function GetFileName ( _
    iItem As UInteger, _
    <OutAttribute> ByRef pbstrFilename As String _
) As Integer

int GetFileName(
    uint iItem,
    out string pbstrFilename
)

int GetFileName(
    [InAttribute] unsigned int iItem, 
    [OutAttribute] String^% pbstrFilename
)

abstract GetFileName : 
        iItem:uint32 * 
        pbstrFilename:string byref -> int

function GetFileName(
    iItem : uint, 
    pbstrFilename : String
) : int

Parameters

iItem
Type: System.UInt32
[in] Index of the context item.

pbstrFilename
Type: System.String%
[out] String containing the file name for the 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 vsshell80.idl:

HRESULT IVsCodeDefViewContext::GetFileName(
   ULONG iItem, 
   BSTR *pbstrFileName
);

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