VsExpansionManagerClass.EnumerateExpansions Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Retrieves a list of code snippets for the specified coding language. See EnumerateExpansions(Guid, Int32, String[], Int32, Int32, Int32, IVsExpansionEnumeration).

public:
 virtual int EnumerateExpansions(Guid guidLang, int fShortCutOnly, cli::array <System::String ^> ^ bstrTypes, int iCountTypes, int fIncludeNULLType, int fIncludeDuplicates, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsExpansionEnumeration ^ % pEnum);

public virtual int EnumerateExpansions (Guid guidLang, int fShortCutOnly, string[] bstrTypes, int iCountTypes, int fIncludeNULLType, int fIncludeDuplicates, out Microsoft.VisualStudio.TextManager.Interop.IVsExpansionEnumeration pEnum);

abstract member EnumerateExpansions : Guid * int * string[] * int * int * int * IVsExpansionEnumeration -> int
override this.EnumerateExpansions : Guid * int * string[] * int * int * int * IVsExpansionEnumeration -> int

Public Overridable Function EnumerateExpansions (guidLang As Guid, fShortCutOnly As Integer, bstrTypes As String(), iCountTypes As Integer, fIncludeNULLType As Integer, fIncludeDuplicates As Integer, ByRef pEnum As IVsExpansionEnumeration) As Integer

Parameters

guidLang

Guid

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

fShortCutOnly

Int32

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

bstrTypes

String[]

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

iCountTypes

Int32

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

fIncludeNULLType

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

Int32

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

pEnum

IVsExpansionEnumeration

[out] An IVsExpansionEnumeration object that contains the desired list of snippets.

Returns

Int32

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

Implements

EnumerateExpansions(Guid, Int32, String[], Int32, Int32, Int32, IVsExpansionEnumeration)

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.

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.