Edit

IWICImagingFactory::CreateDecoderFromFileHandle method (wincodec.h)

  • Article

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

Syntax

HRESULT CreateDecoderFromFileHandle(
  [in]          ULONG_PTR         hFile,
  [in]          const GUID        *pguidVendor,
  [in]          WICDecodeOptions  metadataOptions,
  [out, retval] IWICBitmapDecoder **ppIDecoder
);

Parameters

[in] hFile

Type: ULONG_PTR

The file handle to create the decoder from.

[in] pguidVendor

Type: const GUID*

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

[in] metadataOptions

Type: WICDecodeOptions

The WICDecodeOptions to use when creating the decoder.

[out, retval] ppIDecoder

Type: IWICBitmapDecoder**

A pointer that receives a pointer to a new IWICBitmapDecoder.

Return value

Type: HRESULT

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

Remarks

When a decoder is created using this method, the file handle must remain alive during the lifetime of the decoder.

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
DLL Windowscodecs.dll

See also

CreateFile

IWICImagingFactory