AddImageFromVariant

Image handling

Description

Adds an image from a variant byte array to the selected document.

Once an image has been added to the document it can be drawn on any page multiple times without further increasing the size of the PDF file.

Supported image file types are: BMP, TIFF, JPEG, PNG, GIF, WMF and EMF.

For BMP and TIFF images, the CompressImages function can called before calling this function to compress the image data. Other image types are automatically compressed.

Syntax

Delphi

This function is not available in the Delphi edition

ActiveX

Function DebenuPDFLibrary1811.PDFLibrary::AddImageFromVariant(SourceData As Variant,
  Options As Long) As Long

DLL

This function is not available in the DLL edition

Parameters

SourceData

A variant containing the image data

Options

For multi-page TIFF images this parameter specifies the page number to load. For PNG images: 0 = Load the image as usual 1 = Load the alpha channel as a greyscale image 2 = Load the image and alpha channel (limit alpha to 8-bit) 3 = Load the image (limit image 8-bit/channel) 4 = Load the alpha channel (limit to 8-bit/channel) 5 = Load the image with alpha channel (limit both to 8-bit/channel) 6 = Load the image and alpha channel 7 = Load the image and ICC color profile For other image types this parameter should be set to 0. Setting Options to -1 forces TIFF, EMF and WMF images to be loaded using the GDI+ graphics library. Multipage TIFF images can also be loaded using GDI+ by setting the Options parameter to -PageNumber (for example -3 for page 3).

Return values

0	The image could not be added
Non-zero	The image was added successfully. This is the ID of the new image.