Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

IWICImagingFactory::CreateDecoderFromFilename method (wincodec.h)

Creates a new instance of the IWICBitmapDecoder class based on the given file.

Syntax

HRESULT CreateDecoderFromFilename(
 [in] LPCWSTR wzFilename,
 [in] const GUID *pguidVendor,
 [in] DWORD dwDesiredAccess,
 [in] WICDecodeOptions metadataOptions,
 [out, retval] IWICBitmapDecoder **ppIDecoder
);

Parameters

[in] wzFilename

Type: LPCWSTR

A pointer to a null-terminated string that specifies the name of an object to create or open.

[in] pguidVendor

Type: const GUID*

The GUID for the preferred decoder vendor. Use NULL if no preferred vendor.

[in] dwDesiredAccess

Type: DWORD

The access to the object, which can be read, write, or both.

Value Meaning
GENERIC_READ
Read access.
GENERIC_WRITE
Write access.
 

For more information, see Generic Access Rights.

[in] metadataOptions

Type: WICDecodeOptions

The WICDecodeOptions to use when creating the decoder.

[out, retval] ppIDecoder

Type: IWICBitmapDecoder**

A pointer that receives a pointer to the new IWICBitmapDecoder.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header wincodec.h
Library Windowscodecs.lib

Feedback

Was this page helpful?

Additional resources