IShellImageDataFactory::CreateImageFromFile method
Creates an instance of the IShellImageData interface based on a given file.
Syntax
HRESULT CreateImageFromFile(
[in] LPCWSTR pszPath,
[out] IShellImageData **ppshimg
);
Parameters
- pszPath [in]
-
Type: LPCWSTR
The path of the file containing the image. If this parameter is NULL, an unhandled exception results.
- ppshimg [out]
-
Type: IShellImageData**
The address of a pointer to an instance of IShellImageData.
Return value
Type: HRESULT
Returns S_OK if successful, or an error value otherwise, including the following:
| Return code | Description |
|---|---|
|
The internal object cannot be instantiated. |
|
The internal object does not support the IShellImageData or IPersistFile interfaces. |
|
The ppshimg parameter is NULL. |
Remarks
An access violation occurs if pszPath is NULL.
Requirements
|
Minimum supported client |
Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2003 [desktop apps only] |
|
Header |
|
|
IDL |
|
|
DLL |
|
Show: