package cpdf

  1. Overview
  2. Docs

Module Cpdfattach

type t = {
  1. name : string;
  2. pagenumber : int;
  3. data : unit -> Pdfio.bytes;
  4. description : string option;
  5. relationship : string option;
}

File Attachments

val remove_unsafe_characters : string -> string

Remove characters which might not make good filenames from a UTF8 string.

val attach_file : ?memory:Pdfio.bytes -> bool -> int option -> Pdf.t -> string option -> string option -> string -> Pdf.t

attach_file keepversion topage pdf relationship description filename attaches the file in filename to the pdf, optionally to a page (rather than document-level). If keepversion is true, the PDF version number won't be altered.

val remove_attached_files : Pdf.t -> Pdf.t

Remove attached files.

val list_attached_files : Pdf.t -> t list

List attached files. Attachment name and page number. Page 0 is document level.

val dump_attached_files : Pdf.t -> string -> unit

Dump attached files to a given directory.

val size_attached_files : Pdf.t -> int

Total size in bytes of all attached files.