The following Application Programming Interface functions to Image to PDF are optional:
I2PDF_DeleteImagesOnConvert | |
---|---|
Parameters: | None |
Return Value: | None |
Notes: | Use this with caution - if this is accidentally used you may be unable to recover any images deleted. |
I2PDF_Log | |
---|---|
Parameters: | logFilename - specifies the name and location of the log file. logLevel - any combination of the following: 0 (normal logging), 1 (include image information), 2 (include font matching information), 4 (include filename wildcard matching information), 8 (include Bates number information) |
Return Value: | 0 - success 1 - invalid logFilename parameter |
Notes: |
I2PDF_WildcardFilenameUse | |
---|---|
Parameters: | flags - must be one of the following: 0 (default of one PDF produced per image with no recursion), 1 (one PDF per directory), 2 (recurse down sub-directories), 3 (both one PDF per directory and recursion) |
Return Value: | 0 - success 1 - images have already been added |
Notes: |
I2PDF_TreatImageNumericExtensionAs I2PDF_TreatImageNumericExtAs | |
---|---|
Parameters: | imageExtension - must be a valid image file extension: ".jpg", ".tif", ".png", ".gif", ".bmp", ".wmf", ".emf", ".tga" or ".pcx" |
Return Value: | 0 - success 1 - invalid imageExtension parameter 2 - imageExtension does not start with a "." 3 - imageExtension is not 4 characters long |
Notes: |
I2PDF_TreatImageTmpExtensionAs I2PDF_TreatImageTmpExtAs | |
---|---|
Parameters: | imageExtension - must be a valid image file extension: ".jpg", ".tif", ".png", ".gif", ".bmp", ".wmf", ".emf", ".tga" or ".pcx" |
Return Value: | 0 - success 1 - invalid imageExtension parameter 2 - imageExtension does not start with a "." 3 - imageExtension is not 4 characters long |
Notes: |
I2PDF_TreatImageExtensionAs I2PDF_TreatImageExtAs | |
---|---|
Parameters: | sourceExtension - must be a file extension starting with "." - can be up to 10 characters long. targetExtension - must be a valid image file extension: ".jpg", ".tif", ".png", ".gif", ".bmp", ".wmf", ".emf", ".tga" or ".pcx" |
Return Value: | 0 - success 1 - invalid sourceExtension parameter 2 - sourceExtension does not start with a "." 3 - invalid targetExtension parameter 4 - targetExtension does not start with a "." 5 - targetExtension is not 4 characters long 6 - max image extension mappings already defined |
Notes: |
I2PDF_Reset | |
---|---|
Parameters: | None |
Return Value: | None |
Notes: |
I2PDF_GetDLLVersion | |
---|---|
Parameters: | None |
Return Value: | Version number of the dll multiplied by one hundred, eg a value of 100 is equivalent to version 1.00. |
Notes: |
I2PDF_SilentRunning | |
---|---|
Parameters: | None |
Return Value: | None |
Notes: |
I2PDF_PreventPDFOverwrite | |
---|---|
Parameters: | None |
Return Value: | None |
Notes: |
I2PDF_SaveFailureBackupPDF | |
---|---|
Parameters: | filename - specifies the name and location of the backup PDF document. |
Return Value: | 0 - success 1 - invalid filename parameter |
Notes: |
I2PDF_IncludeTIFFOCRText | |
---|---|
Parameters: | None |
Return Value: | None |
Notes: |
I2PDF_SaveTIFFOCRText | |
---|---|
Parameters: | text - can either be the set value FilePerPage which will save the OCR'd text in a file numbered per page or it is the additional text (maximum of 256 characters) between the default two blank lines that are output between pages of text. If spaces are required in the text then enclose it within quotes. Use \n in the text to force a newline to be output. |
Return Value: | None |
Notes: |
I2PDF_LoadImageFailureSkip I2PDF_LoadImageFailSkip | |
---|---|
Parameters: | None |
Return Value: | None |
Notes: |
I2PDF_LoadImageFailureCopyTo I2PDF_LoadImageFailCopyTo | |
---|---|
Parameters: | directory - specifies the name and location of the directory to hold copied images. |
Return Value: | 0 - success 1 - invalid directory |
Notes: |
I2PDF_LoadImageFailurePage_Real I2PDF_LoadImageFailPg_Real | |
---|---|
Parameters: | width - specifies the page width. Must be a value between 100 and 2000 points inclusive. height - specifies the page height. Must be a value between 100 and 2000 points inclusive. backgroundRed - specifies the red component of the background color. Value must be between 0.0 and 1.0 inclusive. backgroundGreen - specifies the green component of the background color. Value must be between 0.0 and 1.0 inclusive. backgroundBlue - specifies the blue component of the background color. Value must be between 0.0 and 1.0 inclusive. message - text (up to 500 characters) with any combination of special formatting markup characters: |
Return Value: | 0 - success 1 - invalid width 2 - invalid height 3 - invalid backgroundRed 4 - invalid backgroundGreen 5 - invalid backgroundBlue 6 - invalid message |
Notes: |
I2PDF_LoadImageFailurePage_Int I2PDF_LoadImageFailPg_Int | |
---|---|
Parameters: | width - specifies the page width. Must be a value between 100 and 2000 points inclusive. height - specifies the page height. Must be a value between 100 and 2000 points inclusive. backgroundRed - specifies the red component of the background color. Value must be between 0 and 255 inclusive. backgroundGreen - specifies the green component of the background color. Value must be between 0 and 255 inclusive. backgroundBlue - specifies the blue component of the background color. Value must be between 0 and 255 inclusive. message - text (up to 500 characters) with any combination of special formatting markup characters: |
Return Value: | 0 - success 1 - invalid width 2 - invalid height 3 - invalid backgroundRed 4 - invalid backgroundGreen 5 - invalid backgroundBlue 6 - invalid message |
Notes: |
I2PDF_LoadImageFailurePage_Web I2PDF_LoadImageFailPg_Web | |
---|---|
Parameters: | width - specifies the page width. Must be a value between 100 and 2000 points inclusive. height - specifies the page height. Must be a value between 100 and 2000 points inclusive. backgroundColor - specified as a hexadecimal string (from #000000 to #FFFFFF). message - text (up to 500 characters) with any combination of special formatting markup characters: |
Return Value: | 0 - success 1 - invalid width 2 - invalid height 3 - invalid backgroundColor 4 - invalid message |
Notes: |
I2PDF_LoadImageFailurePageFont_Real I2PDF_LoadImageFailPgFnt_Real | |
---|---|
Parameters: | size - must be between 1 and 300 points inclusive. font - must be one of the following standard PDF fonts (which are also known as base14 fonts): Courier, Courier-Bold, Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold, Helvetica-BoldOblique, Helvetica-Oblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic fillRed - specifies the red component of the fill color. Value must be between 0.0 and 1.0 inclusive. fillGreen - specifies the green component of the fill color. Value must be between 0.0 and 1.0 inclusive. fillBlue - specifies the blue component of the fill color. Value must be between 0.0 and 1.0 inclusive. style - must be one of the following: TEXT_STYLE_NORMAL (1) - text is filled in with the required fill color TEXT_STYLE_STROKE (2) - text is filled in with the required fill color and the outline of each letter is "stroked" in the other color otherRed - specifies the red component of the "other" color. Value must be between 0.0 and 1.0 inclusive. otherGreen - specifies the green component of "other" color. Value must be between 0.0 and 1.0 inclusive. otherBlue - specifies the blue component of "other" color. Value must be between 0.0 and 1.0 inclusive. |
Return Value: | 0 - success 1 - invalid size 2 - invalid font 3 - invalid fillRed 4 - invalid fillGreen 5 - invalid fillBlue 6 - invalid style 7 - invalid otherRed 8 - invalid otherGreen 9 - invalid otherBlue |
Notes: |
I2PDF_LoadImageFailurePageFont_Int I2PDF_LoadImageFailPgFnt_Int | |
---|---|
Parameters: | size - must be between 1 and 300 points inclusive. font - must be one of the following standard PDF fonts (which are also known as base14 fonts): Courier, Courier-Bold, Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold, Helvetica-BoldOblique, Helvetica-Oblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic fillRed - specifies the red component of the fill color. Value must be between 0 and 255 inclusive. fillGreen - specifies the green component of the fill color. Value must be between 0 and 255 inclusive. fillBlue - specifies the blue component of the fill color. Value must be between 0 and 255 inclusive. style - must be one of the following: TEXT_STYLE_NORMAL (1) - text is filled in with the required fill color TEXT_STYLE_STROKE (2) - text is filled in with the required fill color and the outline of each letter is "stroked" in the other color otherRed - specifies the red component of the "other" color. Value must be between 0 and 255 inclusive. otherGreen - specifies the green component of "other" color. Value must be between 0 and 255 inclusive. otherBlue - specifies the blue component of "other" color. Value must be between 0 and 255 inclusive. |
Return Value: | 0 - success 1 - invalid size 2 - invalid font 3 - invalid fillRed 4 - invalid fillGreen 5 - invalid fillBlue 6 - invalid style 7 - invalid otherRed 8 - invalid otherGreen 9 - invalid otherBlue |
Notes: |
I2PDF_LoadImageFailurePageFont_Web I2PDF_LoadImageFailPgFnt_Web | |
---|---|
Parameters: | size - must be between 1 and 300 points inclusive. font - must be one of the following standard PDF fonts (which are also known as base14 fonts): Courier, Courier-Bold, Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold, Helvetica-BoldOblique, Helvetica-Oblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic fillColor - specified as a hexadecimal string (from #000000 to #FFFFFF) style - must be one of the following: TEXT_STYLE_NORMAL (1) - text is filled in with the required fill color TEXT_STYLE_STROKE (2) - text is filled in with the required fill color and the outline of each letter is "stroked" in the other color otherColor - specified as a hexadecimal string (from #000000 to #FFFFFF) |
Return Value: | 0 - success 1 - invalid size 2 - invalid font 3 - invalid fillColor 4 - invalid style 5 - invalid otherColor |
Notes: |
I2PDF_MinImageSize | |
---|---|
Parameters: | width - specifies the minimum image width required for an image to be converted. height - specifies the minimum image height required for an image to be converted. |
Notes: |