IShellLibrary::GetIcon method

Gets the default icon for the library.

Syntax


HRESULT GetIcon(
  [out] LPWSTR *ppszIcon
);

Parameters

ppszIcon [out]

Type: LPWSTR*

A null-terminated Unicode string that describes the location of the default icon. The string is returned as ModuleFileName,ResourceIndex or ModuleFileName,-ResourceID.

ValueDescription
ModuleFileNameThe file name of the module file that contains the icon resource.
ResourceIndexIf the number that follows the comma is positive, the index of the resource in the module file.
-ResourceIDIf the number that follows the comma is negative, the absolute value of the number is the resource ID of the icon in the module file.

 

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

For additional information on parsing the string returned in ppszIcon, see PathParseIconLocation.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

See also

IShellLibrary
Windows Libraries
PathParseIconLocation
Library Description Schema

 

 

Show: