Set the description of an embedded file attachment

Writes the /Desc entry of the attachment's file specification dictionary (ISO 32000-1:2008 section 7.11.3) — the human-readable description PDF viewers show in their attachments panel. Wraps FPDFAttachment_SetDescription. Unlike the /Params entries written by pdf_attachment_set_dict_value(), the description works on a fresh attachment before any data is set and survives a later pdf_attachment_set_data().

Usage

pdf_attachment_set_description(att, value)

Arguments

att

A pdfium_attachment from pdf_attachments() or pdf_attachment_new(). Parent doc must be readwrite.

value

Character scalar (UTF-8); "" stores an empty description.

Value

Invisibly returns the parent pdfium_doc.

See also

pdf_attachment_description() for the read side.