IPXC_Document::AddImageFromMemory Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 3: Line 3:
 
{{#customTitle:IPXC_Document::AddImageFromMemory Method}}
 
{{#customTitle:IPXC_Document::AddImageFromMemory Method}}
 
{{#parentPage:PXV:IPXC_Document#Methods|AddImageFromMemory|method}}
 
{{#parentPage:PXV:IPXC_Document#Methods|AddImageFromMemory|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 34: Line 33:
 
:[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation.
 
:[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] 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]]
 
[[PXV:IPXC_Document|IPXC_Document]]

Revision as of 16:00, 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] Returns an IPXC_Image object of newly created image.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXC_Document