IPXC_Document::AddImageFromMemory Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
Line 6: | Line 6: | ||
{{ToReview}} | {{ToReview}} | ||
− | + | Adds a new image into the document based on image data located in the memory. This methods creates an [[PXV:IIXC_Page|image page]] based on memory data and than [[PXV:IPXC_Document_AddImageFromIXCPage]] adds it to the document. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT AddImageFromMemory([in] | + | <pre class="brush:cpp;gutter:false">HRESULT AddImageFromMemory([in] BYTE* Data, |
[in] ULONG dataSize, | [in] ULONG dataSize, | ||
[in] ULONG nWidth, | [in] ULONG nWidth, | ||
Line 20: | Line 20: | ||
== Parameters == | == Parameters == | ||
;Data | ;Data | ||
− | :[in] | + | :[in] Pointer to the start of memory data. |
;dataSize | ;dataSize | ||
− | :[in] | + | :[in] Specifies a length of the memory data pointed by ''Data'' parameter. |
;nWidth | ;nWidth | ||
− | :[in] | + | :[in] Specifies a width of the image in pixels. |
;nHeight | ;nHeight | ||
− | :[in] | + | :[in] Specifies a height of the image in pixels. |
;nStride | ;nStride | ||
− | :[in] | + | :[in] Specifies an amount of bytes the should be added to a pointer to switch to the next line of the image. |
;nType | ;nType | ||
− | :[in] | + | :[in] Specifies a kind of [[PXV:PXC_ImgMemType|image organization]] in the memory. |
;dwFlags | ;dwFlags | ||
:[in, defaultvalue(0)] Value of ULONG. | :[in, defaultvalue(0)] Value of ULONG. |
Revision as of 15:57, 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)] Value of ULONG.
- ppImage
- [out, retval] Pointer to IPXC_Image.
Return Value
Returns S_OK if operation was successful or error code in other cases.