IVsObjectList2.GetSourceContext(UInt32, IntPtr, UInt32) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns a source filename and line number for the given list item.

public:
 int GetSourceContext(System::UInt32 index, IntPtr pszFilename, [Runtime::InteropServices::Out] System::UInt32 % pulLineNum);

public int GetSourceContext (uint index, IntPtr pszFilename, out uint pulLineNum);

abstract member GetSourceContext : uint32 * nativeint * uint32 -> int

Public Function GetSourceContext (index As UInteger, pszFilename As IntPtr, ByRef pulLineNum As UInteger) As Integer

Parameters

index

UInt32

[in] Specifies the index of the list item of interest.

pszFilename

IntPtr

nativeint

[out] Pointer to a null-terminated string containing the file name. You must allocate this buffer and free it on the list's final Release, but you can reuse this buffer for multiple calls to this method.

pulLineNum

UInt32

[out] Specifies a line number.

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

[[C++]

HRESULT IVsObjectList2::GetSourceContext(  
   [in] ULONG Index,   
   [out] const WCHAR **pszFileName,   
   [out] ULONG *pulLineNum  
);  

This method is used to display the source file and line number in the find symbol results window. You can return E_NOTIMPL if you don't want to display this information.

The text buffer is created by the IVsObjectList2 object, and the buffer must persist for the life of the IVsObjectList2 object.

If you are implementing this interface in managed code and you need to have the string disposed by the caller, implement the IVsCoTaskMemFreeMyStrings interface on the IVsObjectList2 interface.