PDF Meta Information Application Programming Interfaces

The following Application Programming Interface functions to Image to PDF all set some aspect of meta information which can be stored within a PDF document. These items of information are usually available/displayable through the PDF viewer.

Important Note: You should always use I2PDF_SetProducer - see below for details.

  I2PDF_SetAuthor
Parameters: author - string between 1 and 256 characters
Return Value: 0 - success
1 - invalid parameter
Notes:
  • The name of the person who created the PDF document.

  •   I2PDF_SetCreator
    Parameters: creator - string between 1 and 256 characters
    Return Value: 0 - success
    1 - invalid parameter
    Notes:
  • If the document was converted into a PDF document from another form, this is usually the name of the application that created the original document.

  •   I2PDF_SetProducer
    Parameters: producer - string between 1 and 256 characters
    Return Value: 0 - success
    1 - invalid parameter
    Notes:
  • The name of the application that converted the document from its native format to PDF.
  • If this item is not set then some applications that can manipulate and re-write the PDF (such as Adobe Acrobat) may not be able to save the file. We recommend that you always set the producer information.
  • Also, if this item is not set then it would appear that in some versions of Adobe Reader the document information dialog does not display the document dimensions, encoding etc.
  • NB Due to the issues outlined above, as of version 2.0 this attribute is set to the default text "Image to PDF by Utility Warrior (http://www.UtilityWarrior.com)" - you can of course change this to whatever you want.

  •   I2PDF_SetTitle
    Parameters: title - string between 1 and 256 characters
    Return Value: 0 - success
    1 - invalid parameter
    Notes:
  • The PDF document's title.

  •   I2PDF_SetSubject
    Parameters: subject - string between 1 and 256 characters
    Return Value: 0 - success
    1 - invalid parameter
    Notes:
  • The PDF document's subject.

  •   I2PDF_SetKeywords
    Parameters: keywords - string between 1 and 256 characters
    Return Value: 0 - success
    1 - invalid parameter
    Notes:
  • A list of keywords associated with the PDF document.

  •   I2PDF_SetCreationDate
    Parameters: None
    Return Value: None
    Notes:
  • The date that the PDF document was created. This is set using the current local time of the PC.