Tracker Software Products
Online Help System
Search:
Contents
IndexBookmarkPrint

Home >  >  > Orphaned Pages

PXCp_SetDocumentInfoA

PXCp_SetDocumentInfoA stores standard information field data regarding the structure of a pdf object (for example when using a mouse in Windows Explorer and selecting a file - this information becomes viewable when you 'right click' and select the 'Properties' option).

HRESULT PXCp_SetDocumentInfoA(
   PDFDocument pDocument,
   PXC_StdInfoField field,
   LPCSTR KeyVal
);


Parameters

pDocument

[in] pDocument specifies the PDF object previously created by the function PXCp_Init.

field

[in] field specifies information tag to be set. Possible values are:

Value

Meaning

InfoField_Title

Sets the Title field in the info structure of the pdf file.

InfoField_Subject

Sets the Subject field in the info structure of the pdf file.

InfoField_Author

Sets the Author field in the info structure of the pdf file.

InfoField_Keywords

Sets the Keywords field in the info structure of the pdf file.

InfoField_Creator

Sets the Creator field in the info structure of the pdf file.

InfoField_Producer

Sets the Producer field in the info structure of the pdf file.

KeyVal

[in] Pointer to a null-terminated ASCII string that specifies the value for the field field.

Return Values

If the function succeeds, the return value is a non-negative integer.

If the function fails, the return value is error code.

To determine if the function was successful use the defined macro's as described here: error codes page.

Comments

This function is the ASCII equivalent of UNICODE function PXCp_SetDocumentInfoW.

Example (C++)

PDFDocument        hDocument;
  LPCSTR        DocTitle = "This is the new document title";
  // Set new title:

  HRESULT res = PXCp_SetDocumentInfoA(hDocument, InfoField_Title, DocTitle);
  if (IS_DS_FAILED(res))
  {
      // Report an error
  }
  ...
  // Clean up

  PXCp_Delete(hDocument);


See also


Was this information helpful?YesNo