IVsExpansionManager.EnumerateExpansions Method (Guid, Int32, String[], Int32, Int32, Int32, IVsExpansionEnumeration)

 

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)

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

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: 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.

pEnum
Type: Microsoft.VisualStudio.TextManager.Interop.IVsExpansionEnumeration

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

Return Value

Type: System.Int32

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

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 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.1a7a93ab-1af1-4f38-babf-a9aa5315b45c

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.

Return to top
Show: