IVsExpansionSession.GetHeaderNode(String, IXMLDOMNode) Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns a node from the code snippet <Header> tag.

public:
 int GetHeaderNode(System::String ^ bstrNode, [Runtime::InteropServices::Out] MSXML::IXMLDOMNode ^ % pNode);

public:
 int GetHeaderNode(Platform::String ^ bstrNode, [Runtime::InteropServices::Out] MSXML::IXMLDOMNode ^ &  pNode);

int GetHeaderNode(std::wstring const & bstrNode, [Runtime::InteropServices::Out] MSXML::IXMLDOMNode const & & pNode);

public int GetHeaderNode (string bstrNode, out MSXML.IXMLDOMNode pNode);

abstract member GetHeaderNode : string * IXMLDOMNode -> int

Public Function GetHeaderNode (bstrNode As String, ByRef pNode As IXMLDOMNode) As Integer

Parameters

bstrNode

String

[in] A string containing the name of the XML tag to look for. This can be null. See Remarks.

pNode

IXMLDOMNode

[out] Returns a node that represents the specified tag.

Returns

Int32

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

Remarks

COM Signature

From textmgr2.idl:

HRESULT IVsExpansionSession::GetHeaderNode(  
   [in] BSTR bstrNode,  
   [out] IXMLDOMNode **pNode  
);  

This method provides access to the header information of the code snippet such as author, description, title, and more. See Header Element (Intellisense Code Snippets) for details on what tags can be searched for.

If the bstrNode parameter is a null value, this method returns the node of the <Header> tag itself. If the bstrNode parameter is not a null value, this method searches the tags in the <Header> tag node for the specified tag.