GdPictureImaging.PdfAddImageFromGdPictureImage Method (Integer, Integer, Boolean)

Adds an image from a GdPicture Image to a PDF. This function takes a parameter to define if the image must be treated as image mask.

public int PdfAddImageFromGdPictureImage(
    int PdfID, 
    int ImageID, 
    Boolean ImageMask
);

Visual Basic

Public Function PdfAddImageFromGdPictureImage(
    ByVal PdfID As Integer, 
    ByVal ImageID As Integer, 
    ByVal ImageMask As Boolean
) As Integer

Parameters

Parameters	Description
PdfID	A PDF identifier returned by the PdfNewPdf(), PdfOCRStart(), PdfOcrStartStream(), TwainPDFStart() or TwainPdfStartStream() function.
ImageID	GdPicture Image Identifier. The image to add within the PDF.
ImageMask	Only for 1BPP (1 Bit Per Pixel)image! Indicates whether the image shall be treated as an image mask (False by default). See sample provided into the PdfAddImageFromFile function.

Returns

Returns an incremental Pdf image number if success, else 0. This pdf image number can be used with the PdfDrawImage() function.