SetSignProcessFieldImageFromFile

Security and Signatures

Description

Sets the image to use for a visual signature field in the specified digital signature process.

The SetSignProcessFieldBounds function can be used to specify the location and size of the signature field.

Syntax

Delphi

function TPDFlib.SetSignProcessFieldImageFromFile(SignProcessID: Integer; Const ImageFileName: WideString; Options: Integer): Integer;

ActiveX

Function PDFlib::SetSignProcessFieldImageFromFile(SignProcessID As Long, ImageFileName As String, Options As Long) As Long

DLL

int DLSetSignProcessFieldImageFromFile(int InstanceID, int SignProcessID, wchar_t * ImageFileName, int Options);

Parameters

SignProcessIDA value returned by the NewSignProcessFromFile, NewSignProcessFromStream or NewSignProcessFromString functions.
ImageFileNameThe path and file name of the image to use for the visual signature.
OptionsFor 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

0Image could not be added
1Success