IPXC_Document::AddImageFromFile Method
From PDF XChange PDF SDK
Adds new image to the document from specified image file. Image data compressed based on image type (monochrome, indexed, true color) and corresponding encoder array.
Syntax
HRESULT AddImageFromFile([in] LPWSTR sFileName, [in, defaultvalue(0)] ULONG nPage, [in, defaultvalue(0)] ULONG nFlags, [out, retval] IPXC_Image** pImage);
Parameters
- sFileName
- [in] Specifies a full file name of the image file. The file should be an image in one of supported format: BMP, PNG, GIF, ICO, PBM, PGM, PPM, JBIG, JBIG2, JPEG, JPEG2000, PXC, DCX, TGA or TIFF.
- nPage
- [in, defaultvalue(0)] Specifies the 0-based page number of multipaged image formats (like, TIFF or ICO) that should be taken.
- nFlags
- [in, defaultvalue(0)] Specifies additional flags of image creation.
- pImage
- [out, retval] Returns a IPXC_Image object if new image was successfully added.
Return Value
Returns S_OK if operation was successful or error code in other cases.