IVsExpansionSession::GetHeaderNode Method (String^, IXMLDOMNode^)

Visual Studio 2015

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

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop.8.0 (in Microsoft.VisualStudio.TextManager.Interop.8.0.dll)

Syntax

C++

int GetHeaderNode(
	String^ bstrNode,
	[OutAttribute] IXMLDOMNode^% pNode
)

Parameters

bstrNode: Type: System::String^
[in] A string containing the name of the XML tag to look for. This can be null. See Remarks.

pNode: Type: MSXML::IXMLDOMNode^
[out] Returns a node that represents the specified tag.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From textmgr2.idl:

C++

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 for details on what tags can be searched for.291c4b6d-8c83-42fd-9384-285f639af3a5

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.