IPXC_Document::AddImageFromFile Method

From Tracker Software PDF SDK
Jump to: navigation, search
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}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  

Revision as of 16:44, 25 May 2015


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**  ppImage);

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 options. Reserved for future usage and must be zero.
ppImage
[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.

See Also

IPXC_Document, IPXC_Image