Attachment Object

An Attachment object represents a single attached file that is physically stored in the user database.

An Attachment object:

  • Stores information about that file (description, unique key, path name, and size) in the Attachment object's properties.
  • Provides a means to manipulate the file.
Note: The HCL Compass API does not permit you to alter that data inside an attached file, but it does permit you to alter the descriptive information.

In order to:

  • Attach files to a database, use the Add method of the Attachments Object. (You never create instances of Attachment directly.)
  • Retrieve an Attachment object, use the Item method of the Attachments object.
  • Delete an Attachment object, use the Delete method of the Attachments Object.
  • Copy an existing attachment to a new file, use the Load method.