Share via


IVsStructuredFileIO.GetFormatList Method

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function GetFormatList ( _
    szEntityName As String, _
    szFileTypes As String, _
    <OutAttribute> ByRef ppszFormatList As String _
) As Integer
int GetFormatList(
    string szEntityName,
    string szFileTypes,
    out string ppszFormatList
)
int GetFormatList(
    [InAttribute] String^ szEntityName, 
    [InAttribute] String^ szFileTypes, 
    [OutAttribute] String^% ppszFormatList
)
abstract GetFormatList : 
        szEntityName:string * 
        szFileTypes:string * 
        ppszFormatList:string byref -> int 
function GetFormatList(
    szEntityName : String, 
    szFileTypes : String, 
    ppszFormatList : String
) : int

Parameters

  • szEntityName
    Type: System.String
    [in] Null-terminated string containing the entity name, for example, "Distribution Unit Project File" or "VB Project File.".
  • szFileTypes
    Type: System.String
    [in] Null-terminated string containing the file types. This is a semicolon-separated list of file extensions.
  • ppszFormatList
    Type: System.String%
    [out] Specifies the location in which the file format list will be stored.

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

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

.NET Framework Security

See Also

Reference

IVsStructuredFileIO Interface

Microsoft.VisualStudio.Shell.Interop Namespace