Share via

IVsImageService.GetIconForFile(String, __VSUIDATAFORMAT) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assemblies:
Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.11.0.dll
Assemblies:
Microsoft.VisualStudio.LanguageServer.Client.dll, Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.11.0.dll
Assembly:
Microsoft.VisualStudio.Shell.Interop.11.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Caution

Use IVsImageService2.GetImageMonikerForFile instead

Gets the 16x16 icon for the specified file.

public:
 Microsoft::VisualStudio::Shell::Interop::IVsUIObject ^ GetIconForFile(System::String ^ filename, Microsoft::VisualStudio::Shell::Interop::__VSUIDATAFORMAT desiredFormat);
public:
 Microsoft::VisualStudio::Shell::Interop::IVsUIObject ^ GetIconForFile(Platform::String ^ filename, Microsoft::VisualStudio::Shell::Interop::__VSUIDATAFORMAT desiredFormat);
Microsoft::VisualStudio::Shell::Interop::IVsUIObject GetIconForFile(std::wstring const & filename, Microsoft::VisualStudio::Shell::Interop::__VSUIDATAFORMAT desiredFormat);
public Microsoft.VisualStudio.Shell.Interop.IVsUIObject GetIconForFile (string filename, Microsoft.VisualStudio.Shell.Interop.__VSUIDATAFORMAT desiredFormat);
[System.Obsolete("Use IVsImageService2.GetImageMonikerForFile instead")]
public Microsoft.VisualStudio.Shell.Interop.IVsUIObject GetIconForFile (string filename, Microsoft.VisualStudio.Shell.Interop.__VSUIDATAFORMAT desiredFormat);
abstract member GetIconForFile : string * Microsoft.VisualStudio.Shell.Interop.__VSUIDATAFORMAT -> Microsoft.VisualStudio.Shell.Interop.IVsUIObject
[<System.Obsolete("Use IVsImageService2.GetImageMonikerForFile instead")>]
abstract member GetIconForFile : string * Microsoft.VisualStudio.Shell.Interop.__VSUIDATAFORMAT -> Microsoft.VisualStudio.Shell.Interop.IVsUIObject
Public Function GetIconForFile (filename As String, desiredFormat As __VSUIDATAFORMAT) As IVsUIObject

Parameters

filename
String

[in] The file name of the icon.

desiredFormat
__VSUIDATAFORMAT

[in] The data format used in the user interface.

Returns

IVsUIObject

The icon object. Returns null if the icon cannot be retrieved.

Attributes
ObsoleteAttribute

Applies to