IWICImagingFactory::CreateDecoderFromFileHandle method
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
- hFile [in]
-
Type: ULONG_PTR
The file handle to create the decoder from.
- pguidVendor [in]
-
Type: const GUID*
The GUID for the preferred decoder vendor. Use NULL if no preferred vendor.
- metadataOptions [in]
-
Type: WICDecodeOptions
The WICDecodeOptions to use when creating the decoder.
- ppIDecoder [out, retval]
-
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
|
Minimum supported client |
Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2008 [desktop apps | Windows Store apps] |
|
Header |
|
|
IDL |
|
|
Library |
|
|
DLL |
|
See also