ImageGear Professional DLL v17.1 for Windows Accusoft
IG_PDF_doc_set_info
Send Feedback  
ImageGear Professional DLL v17.1 for Windows > API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_DOC > IG_PDF_doc_set_info

Glossary Item Box

This function can be used to set new values for the following standard document information dictionary keys: "Title", "Author", "Subject", "Keywords", and "Creator".

Declaration:

  Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_doc_set_info(
       HIG_PDF_DOC hDoc,
       LPCSTR szInfoKey,
       LPSTR szBuffer,
       LONG nSize);

Arguments:

hDoc The document whose Info dictionary key is set.
szInfoKey The name of the Info dictionary key whose value is set.
szBuffer Buffer containing the value to associate with szInfoKey.
nSize The number of bytes in buffer.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

The following standard document information dictionary keys are read-only: "Producer", "Created", and "Modified"; the library will overwrite the values of these keys on document save.

See Section 10.2.1 on Info dictionaries in the PDF Reference for information about Info dictionaries. All values in the Info dictionary should be strings; other data types such as numbers and Booleans should not be used as values in the Info dictionary. If an info dictionary key is specified that is not currently in the info dictionary, it is added to the dictionary.

©2012. Accusoft Corporation. All Rights Reserved.