IPXC_Document::AddImageFromMemory Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Document::AddImageFromMemory Method}} | {{#customTitle:IPXC_Document::AddImageFromMemory Method}} | ||
| + | {{#parentPage:PXV:IPXC_Document#Methods|AddImageFromMemory|method}} | ||
| + | {{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] UCHAR* Data, [in] ULONG | + | <pre class="brush:cpp;gutter:false">HRESULT AddImageFromMemory([in] UCHAR* 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** pImage);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;Data |
| − | :[in] | + | :[in] Pointer to the start of memory data. |
| − | ; | + | ;datasize |
| − | :[in] | + | :[in] Specifies a length of the memory data pointed by ''Data'' parameter. |
| − | + | ;nWidth | |
| − | :[in] | + | :[in] Specifies a width of the image in pixels. |
| − | ; | + | ;nHeight |
| − | :[in] | + | :[in] Specifies a height of the image in pixels. |
| − | ; | + | ;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 |
| − | :[in] | + | :[in] Specifies a kind of [[PXV:PXC_ImgMemType|image organization]] in the memory. |
| − | ; | + | ;dwFlags |
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation. |
| − | ; | + | ;pImage |
| − | :[out, retval] | + | :[out, retval] Returns an [[PXV:IPXC_Image|IPXC_Image]] object of newly created image. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code in other cases. | + | Returns <tt>S_OK</tt> if operation was successful or error code in other cases. |
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_Document|IPXC_Document]] | |
Latest revision as of 00:27, 12 August 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] UCHAR* 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** pImage);
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.
- pImage
- [out, retval] Returns an IPXC_Image object of newly created image.
Return Value
Returns S_OK if operation was successful or error code in other cases.
