IVsXMLMemberIndex.GetMemberXML Method

Article
04/22/2008

Retrieves the XML source corresponding to a given member.

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

Syntax

'Déclaration
Function GetMemberXML ( _
    dwId As UInteger, _
    <OutAttribute> ByRef pbstrXML As String _
) As Integer
'Utilisation
Dim instance As IVsXMLMemberIndex
Dim dwId As UInteger
Dim pbstrXML As String
Dim returnValue As Integer

returnValue = instance.GetMemberXML(dwId, _
    pbstrXML)

int GetMemberXML(
    uint dwId,
    out string pbstrXML
)

int GetMemberXML(
    [InAttribute] unsigned int dwId, 
    [OutAttribute] String^% pbstrXML
)

function GetMemberXML(
    dwId : uint, 
    pbstrXML : String
) : int

Parameters

dwId
Type: System.UInt32

[in] Unsigned integer. A member identifier generated by the underlying parser. Obtain the identifier from the ParseMemberSignature method.

pbstrXML
Type: System.String%

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

Return Value

Type: System.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
);

Permissions

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