Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
IExtractIcon (Interfaces)
 
.
Summary
Exposes methods that allow a client to retrieve the icon that is associated with one of the objects in a folder.

C# Signature:

// UNICODE version

//Mod by pooya parsa

  [ComImport()]
    [Guid("000214fa-0000-0000-c000-000000000046")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    //http://msdn.microsoft.com/en-us/library/windows/desktop/bb761852(v=vs.85).aspx
    interface IExtractIcon
    {
    /// <summary>
    /// Gets the location and index of an icon.
    /// </summary>
    /// <param name="uFlags">One or more of the following values. This parameter can also be NULL.use GIL_ Consts</param>
    /// <param name="szIconFile">A pointer to a buffer that receives the icon location. The icon location is a null-terminated string that identifies the file that contains the icon.</param>
    /// <param name="cchMax">The size of the buffer, in characters, pointed to by pszIconFile.</param>
    /// <param name="piIndex">A pointer to an int that receives the index of the icon in the file pointed to by pszIconFile.</param>
    /// <param name="pwFlags">A pointer to a UINT value that receives zero or a combination of the following value</param>
    /// <returns></returns>
    ///
    [PreserveSig]
    int GetIconLocation(IExtractIconuFlags uFlags, [Out, MarshalAs(UnmanagedType.LPWStr, SizeParamIndex = 2)] StringBuilder szIconFile, int cchMax, out int piIndex, out IExtractIconpwFlags pwFlags);

    /// <summary>
    /// Extracts an icon image from the specified location.
    /// </summary>
    /// <param name="pszFile">A pointer to a null-terminated string that specifies the icon location.</param>
    /// <param name="nIconIndex">The index of the icon in the file pointed to by pszFile.</param>
    /// <param name="phiconLarge">A pointer to an HICON value that receives the handle to the large icon. This parameter may be NULL.</param>
    /// <param name="phiconSmall">A pointer to an HICON value that receives the handle to the small icon. This parameter may be NULL.</param>
    /// <param name="nIconSize">The desired size of the icon, in pixels. The low word contains the size of the large icon, and the high word contains the size of the small icon. The size specified can be the width or height. The width of an icon always equals its height.</param>
    /// <returns>
    /// Returns S_OK if the function extracted the icon, or S_FALSE if the calling application should extract the icon.
    /// </returns>
    [PreserveSig]
    int Extract([MarshalAs(UnmanagedType.LPWStr)] string pszFile,uint nIconIndex,out IntPtr phiconLarge,out IntPtr phiconSmall,uint nIconSize);

    [Flags()]
    public enum IExtractIconuFlags:uint
    {
        GIL_ASYNC=0x0020,
        GIL_DEFAULTICON =0x0040,
        GIL_FORSHELL =0x0002,
        GIL_FORSHORTCUT =0x0080,
        GIL_OPENICON = 0x0001,
        GIL_CHECKSHIELD = 0x0200
    }

    [Flags()]
    public enum IExtractIconpwFlags : uint
    {
        GIL_DONTCACHE = 0x0010,
        GIL_NOTFILENAME = 0x0008,
        GIL_PERCLASS = 0x0004,
        GIL_PERINSTANCE = 0x0002,
        GIL_SIMULATEDOC = 0x0001,
        GIL_SHIELD = 0x0200,//Windows Vista only
        GIL_FORCENOSHIELD = 0x0400//Windows Vista only
    }

// ANSI version

[ComImport()]
[Guid("000214eb-0000-0000-c000-000000000046")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
interface IExtractIcon
{
   [PreserveSig]
   int GetIconLocation(uint uFlags,
   [MarshalAs(UnmanagedType.LPStr)] StringBuilder szIconFile,
              int cchMax,
              out int piIndex,
              out uint pwFlags);

   [PreserveSig]
   int Extract(string pszFile,
          uint nIconIndex,
          out IntPtr phiconLarge,
          out IntPtr phiconSmall,
          uint nIconSize);
}

VB Signature:

<ComImportAttribute()> _
<GuidAttribute("000214eb-0000-0000-c000-000000000046")> _
<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)> _
Public Interface IExtractIcon
    <PreserveSig()> _
     Function GetIconLocation(ByVal uFlags As Integer, _
          ByVal szIconFile As IntPtr, _
          ByVal cchMax As Integer, _
          ByRef piIndex As Integer, _
          ByRef pwFlags As Integer) As Integer

    <PreserveSig()> _
    Function Extract(ByVal pszFile As IntPtr, _
         ByVal nIconIndex As Integer, _
         ByVal phiconLarge As IntPtr, _
         ByVal phiconSmall As IntPtr, _
         ByVal nIconSize As Integer) As Integer
End Interface

User-Defined Types:

None.

Notes:

GetIconLocation() must be declared before Extract()! If you don't, you will get a cryptic runtime error (Read/write of protected memory).

-> olala...

Documentation

Please edit this page!

Do you have...

  • helpful tips?
  • corrections to the existing content?
  • alternate definitions?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing any supporting types needed.

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions