Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Gets the default icon for the library.
Syntax
HRESULT GetIcon(
[out] LPWSTR *ppszIcon
);
Parameters
[out] ppszIcon
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.
| Value | Description |
|---|---|
| ModuleFileName | The file name of the module file that contains the icon resource. |
| ResourceIndex | If the number that follows the comma is positive, the index of the resource in the module file. |
| -ResourceID | If 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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7 [desktop apps only] |
| Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | shobjidl_core.h (include Shobjidl.h) |