IPXC_Document::AddImageFromMemory Method
From PDF XChange PDF SDK
Line 32: | Line 32: | ||
:[in] Specifies a kind of [[PXV:PXC_ImgMemType|image organization]] in the memory. | :[in] Specifies a kind of [[PXV:PXC_ImgMemType|image organization]] in the memory. | ||
;dwFlags | ;dwFlags | ||
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation. |
;ppImage | ;ppImage | ||
:[out, retval] Pointer to [[PXV:IPXC_Image|IPXC_Image]]. | :[out, retval] Pointer to [[PXV:IPXC_Image|IPXC_Image]]. |
Revision as of 15:58, 25 May 2015
Adds a new image into the document based on image data located in the memory. This methods creates an image page based on memory data and than IPXC_Document::AddImageFromIXCPage Method adds it to the document.
Syntax
HRESULT AddImageFromMemory([in] BYTE* Data, [in] ULONG dataSize, [in] ULONG nWidth, [in] ULONG nHeight, [in] LONG nStride, [in] PXC_ImgMemType nType, [in, defaultvalue(0)] ULONG dwFlags, [out, retval] IPXC_Image** ppImage);
Parameters
- Data
- [in] Pointer to the start of memory data.
- dataSize
- [in] Specifies a length of the memory data pointed by Data parameter.
- nWidth
- [in] Specifies a width of the image in pixels.
- nHeight
- [in] Specifies a height of the image in pixels.
- nStride
- [in] Specifies an amount of bytes the should be added to a pointer to switch to the next line of the image.
- nType
- [in] Specifies a kind of image organization in the memory.
- dwFlags
- [in, defaultvalue(0)] Specifies additional flags of image creation.
- ppImage
- [out, retval] Pointer to IPXC_Image.
Return Value
Returns S_OK if operation was successful or error code in other cases.