[Now Supported on Windows NT]
Extracts an icon image from the specified location.
HRESULT Extract(
| LPCSTR pszFile, | //Points to the icon location specifier |
| UINT nIconIndex, | //Icon index |
| HICON *phiconLarge, | //Points to variable for large icon handle |
| HICON *phiconSmall, | //Points to variable for small icon handle |
| UINT nIconSize | //Specifies the size of the large icon required |
| ); |
Parameters
pszFile
Pointer to a null-terminated string specifying the icon location.
nIconIndex
Icon index.
phiconLarge and phiconSmall
Pointer to the variable that receives the handle of the large icon.
phiconSmall
Pointer to the variable that receives the handle of the small icon.
nIconSize
Value specifying the size, in pixels, of the icon required. The LOWORD and HIWORD specify the size of the large and small icons, respectively. The size specified can be the width or height. The width of an icon always equals its height.
Return Values
Returns NOERROR if the function extracted the icon or S_FALSE if the calling application should extract the icon.
Remarks
The icon location and index are the same values returned by the IExtractIcon::GetIconLocation method. If this function returns S_FALSE, these values must specify an icon filename and index that form legal parameters for a call to ExtractIcon. If this function does not return S_FALSE, the calling application should make no assumptions about the meanings of the pszFile and nIconIndex parameters.
See Also