IVsLibraryMgr.GetNameAt(UInt32, IntPtr) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 displayable name for the requested library.

public:
 int GetNameAt(System::UInt32 nLibIndex, IntPtr pszName);

public int GetNameAt (uint nLibIndex, IntPtr pszName);

abstract member GetNameAt : uint32 * nativeint -> int

Public Function GetNameAt (nLibIndex As UInteger, pszName As IntPtr) As Integer

Parameters

nLibIndex: UInt32

[in] Specifies the zero-based index of the library of interest.

pszName: IntPtr
nativeint

[out] Pointer to a null-terminated string containing the library name.

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 IVsLibraryMgr::GetNameAt(  
   [in] ULONG nLibIndex,  
   [out, retval] WCHAR **pszName  
);

Return a pointer to a null-terminated string containing the displayable name for the designated library. You must allocate the string buffer and keep it valid until the next call to your library manager's GetNameAt method.

Note

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

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

Applies to

Partilhar via