IPXC_Document::AddImageFromFile Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_Document::AddImageFromFile Method}} | {{#customTitle:IPXC_Document::AddImageFromFile Method}} | ||
{{#parentPage:PXV:IPXC_Document#Methods|AddImageFromFile|method}} | {{#parentPage:PXV:IPXC_Document#Methods|AddImageFromFile|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| Line 12: | Line 11: | ||
[in, defaultvalue(0)] ULONG nPage, | [in, defaultvalue(0)] ULONG nPage, | ||
[in, defaultvalue(0)] ULONG nFlags, | [in, defaultvalue(0)] ULONG nFlags, | ||
| − | [out, retval] IPXC_Image** | + | [out, retval] IPXC_Image** pImage);</pre> |
== Parameters == | == Parameters == | ||
| Line 20: | Line 19: | ||
:[in, defaultvalue(0)] Specifies the 0-based page number of multipaged image formats (like, <tt>TIFF</tt> or <tt>ICO</tt>) that should be taken. | :[in, defaultvalue(0)] Specifies the 0-based page number of multipaged image formats (like, <tt>TIFF</tt> or <tt>ICO</tt>) that should be taken. | ||
;nFlags | ;nFlags | ||
| − | :[in, defaultvalue(0)] Specifies additional | + | :[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation. |
| − | ; | + | ;pImage |
:[out, retval] Returns a [[PXV:IPXC_Image|IPXC_Image]] object if new image was successfully added. | :[out, retval] Returns a [[PXV:IPXC_Image|IPXC_Image]] object if new image was successfully added. | ||
| Line 28: | Line 27: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXC_Document|IPXC_Document | + | [[PXV:IPXC_Document|IPXC_Document]] |
Latest revision as of 23:07, 30 November 2017
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.
