IPXC_Document::AddImageFromMemory Method

Latest revision as of 23:27, 11 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.

See Also

IPXC_Document