IVsStructuredFileIO.GetFormatList(String, String, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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);

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:

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