IPXC_Document::AddImageFromMemory Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 6: Line 6:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
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,
+
<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] Pointer to UCHAR.
+
:[in] Pointer to the start of memory data.
 
;dataSize
 
;dataSize
:[in] Value of ULONG.
+
:[in] Specifies a length of the memory data pointed by ''Data'' parameter.
 
;nWidth
 
;nWidth
:[in] Value of ULONG.
+
:[in] Specifies a width of the image in pixels.
 
;nHeight
 
;nHeight
:[in] Value of ULONG.
+
:[in] Specifies a height of the image in pixels.
 
;nStride
 
;nStride
:[in] Value of LONG.
+
:[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] Value of [[PXV:PXC_ImgMemType|PXC_ImgMemType]].
+
:[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 16: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.

See Also

IPXC_Document