IVsExpansionManager.EnumerateExpansions Method

  • Article

Retrieves a list of code snippets for the specified coding language.

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

Syntax

'Declaration
Function EnumerateExpansions ( _
    guidLang As Guid, _
    fShortCutOnly As Integer, _
    bstrTypes As String(), _
    iCountTypes As Integer, _
    fIncludeNULLType As Integer, _
    fIncludeDuplicates As Integer, _
    <OutAttribute> ByRef pEnum As IVsExpansionEnumeration _
) As Integer

int EnumerateExpansions(
    Guid guidLang,
    int fShortCutOnly,
    string[] bstrTypes,
    int iCountTypes,
    int fIncludeNULLType,
    int fIncludeDuplicates,
    out IVsExpansionEnumeration pEnum
)

int EnumerateExpansions(
    [InAttribute] Guid guidLang, 
    [InAttribute] int fShortCutOnly, 
    [InAttribute] array<String^>^ bstrTypes, 
    [InAttribute] int iCountTypes, 
    [InAttribute] int fIncludeNULLType, 
    [InAttribute] int fIncludeDuplicates, 
    [OutAttribute] IVsExpansionEnumeration^% pEnum
)

abstract EnumerateExpansions : 
        guidLang:Guid * 
        fShortCutOnly:int * 
        bstrTypes:string[] * 
        iCountTypes:int * 
        fIncludeNULLType:int * 
        fIncludeDuplicates:int * 
        pEnum:IVsExpansionEnumeration byref -> int

function EnumerateExpansions(
    guidLang : Guid, 
    fShortCutOnly : int, 
    bstrTypes : String[], 
    iCountTypes : int, 
    fIncludeNULLType : int, 
    fIncludeDuplicates : int, 
    pEnum : IVsExpansionEnumeration
) : int

Parameters

  • guidLang
    Type: System.Guid

    [in] The GUID of the coding language (typically, this is the language service GUID).

  • fShortCutOnly
    Type: System.Int32

    [in] Non-zero (TRUE) if to retrieve only the shortcut name for each snippet; otherwise, zero (FALSE) to retrieve all information.

  • bstrTypes
    Type: array<System.String[]

    [in] An array strings specifying snippet types to obtain. This can be a null value if iCountTypes is 0. See Remarks.

  • iCountTypes
    Type: System.Int32

    [in] The number of types specified in the bstrTypes array. If this is 0, all types are returned.

  • fIncludeNULLType
    Type: System.Int32

    [in] Non-zero (TRUE) if to include code snippets with "empty" types in the bstrTypes list (this parameter is ignored if iCountTypes is 0).

  • fIncludeDuplicates
    Type: System.Int32

    [in] Non-zero (TRUE) if to include duplicate snippets; otherwise, duplicates are left out.

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     EnumerateExpansions(
   [in]GUID guidLang,
   [in] bool fShortCutOnly,
   [in, size_is(iCountTypes)] BSTR *bstrTypes,
   [in] long iCountTypes,
   [in] bool fIncludeNULLType,
   [in] bool fIncludeDuplicates,
   [out] IVsExpansionEnumeration **pEnum
);

The bstrTypes list contains strings that specify the types of snippets to retrieve. These types can be "Expansion" or "SurroundsWith" (see SnippetType Element (IntelliSense Code Snippets) for details on snippet types). It is possible for a code snippet to not have a type associated with it in which case, such snippets are not returned unless the fIncludeNULLType parameter is non-zero (TRUE) or the iCountTypes parameter is 0.

Examples

See the Example in the IVsExpansionEnumeration interface topic to see how this method is used to obtain a list of all snippets for a particular coding language.

.NET Framework Security

See Also

Reference

IVsExpansionManager Interface

Microsoft.VisualStudio.TextManager.Interop Namespace

Other Resources

SnippetType Element (IntelliSense Code Snippets)