Share via

IVsExpansionSession.GetHeaderNode Method

  • Article

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

'Declaration
Function GetHeaderNode ( _
    bstrNode As String, _
    <OutAttribute> ByRef pNode As IXMLDOMNode _
) As Integer

int GetHeaderNode(
    string bstrNode,
    out IXMLDOMNode pNode
)

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

abstract GetHeaderNode : 
        bstrNode:string * 
        pNode:IXMLDOMNode byref -> int 

function GetHeaderNode(
    bstrNode : String, 
    pNode : IXMLDOMNode
) : int

Parameters

  • bstrNode
    Type: System.String
    [in] A string containing the name of the XML tag to look for. This can be nulla null reference (Nothing in Visual Basic). See Remarks.
  • pNode
    Type: 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:

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 nulla null reference (Nothing in Visual Basic) value, this method returns the node of the <Header> tag itself. If the bstrNode parameter is not a nulla null reference (Nothing in Visual Basic) value, this method searches the tags in the <Header> tag node for the specified tag.

.NET Framework Security

See Also

Reference

IVsExpansionSession Interface

Microsoft.VisualStudio.TextManager.Interop Namespace

Other Resources

Header Element (IntelliSense Code Snippets)