IVsXMLMemberIndex.GetMemberXML(UInt32, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Retrieves the XML source corresponding to a given member.

public:
 int GetMemberXML(System::UInt32 dwId, [Runtime::InteropServices::Out] System::String ^ % pbstrXML);

int GetMemberXML(unsigned int dwId, [Runtime::InteropServices::Out] std::wstring const & & pbstrXML);

public int GetMemberXML (uint dwId, out string pbstrXML);

abstract member GetMemberXML : uint32 * string -> int

Public Function GetMemberXML (dwId As UInteger, ByRef pbstrXML As String) As Integer

Parameters

dwId

UInt32

[in] Unsigned integer. A member identifier generated by the underlying parser. Obtain the identifier from the ParseMemberSignature(String, UInt32) method.

pbstrXML

String

[out] Pointer to a string containing the XML source.

Returns

Int32

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

Remarks

The XML is surrounded by <doc> </doc> tags, but will otherwise be the exact contents of the XML for the member specified.

Note

This method blocks until the index is completely constructed, should that be happening on another thread. The method begins the process of constructing the index if it has not yet begun (or is out of date relative to the XML file).

COM Signature

From vsshell.idl:

HRESULT IVsXMLMemberIndex::GetMemberXML(  
   [in] DWORD_PTR dwID,   
   [out] BSTR *pbstrXML  
);