IVsStructuredFileIO.GetFormatList(String, String, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.13.40008

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the format list for the file types supported by your VSPackage.

public:
 int GetFormatList(System::String ^ szEntityName, System::String ^ szFileTypes, [Runtime::InteropServices::Out] System::String ^ % ppszFormatList);

C++/WinRT

int GetFormatList(std::wstring const & szEntityName, std::wstring const & szFileTypes, [Runtime::InteropServices::Out] std::wstring const & & ppszFormatList);

public int GetFormatList(string szEntityName, string szFileTypes, out string ppszFormatList);

abstract member GetFormatList : string * string * string -> int

Public Function GetFormatList (szEntityName As String, szFileTypes As String, ByRef ppszFormatList As String) As Integer

Parameters

szEntityName: String

[in] Null-terminated string containing the entity name, for example, "Distribution Unit Project File" or "VB Project File.".

szFileTypes: String

[in] Null-terminated string containing the file types. This is a semicolon-separated list of file extensions.

ppszFormatList: String

[out] Specifies the location in which the file format list will be stored.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

cpp#

HRESULT IVsStructuredFileIO::GetFormatList(  
   [in] LPCOLESTR szEntityName,  
   [in] LPCOLESTR szFileTypes,  
   [out] LPOLESTR *ppszFormatList  
);

Applies to

Product	Versions
Visual Studio SDK	2015, 2017, 2019, 2022

Share via