IShellImageDataFactory::GetDataFormatFromPath method (shimgdata.h)

Article
02/22/2024

Determines a file's format based on its extension.

Syntax

HRESULT GetDataFormatFromPath(
  [in]  LPCWSTR pszPath,
  [out] GUID    *pDataFormat
);

Parameters

[in] pszPath

Type: LPCWSTR

A path to the file.

[out] pDataFormat

Type: GUID*

A pointer to a GUID identifying the image format of the file.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise, including the following:

Return code	Description
E_FAIL	The pszPath parameter is NULL, the file name extension does not correspond to any defined GDI+ decoder, or an internal error has occurred. In any of these cases, pDataFormat is set to GUID_NULL.
E_OUTOFMEMORY	The internal object cannot be instantiated.

Remarks

IShellImageDataFactory::GetDataFormatFromPath should only be used to determine whether data can be saved to a particular format on the current system.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	shimgdata.h
DLL	Shell32.dll

Share via