Delete
Description
Deletes an attached file from the collection.
The argument must be a numeric index.
You
can use the Count and Item methods
to locate the correct Attachment object before calling this method.
Note: The
Entity must be in an editable state before calling the Delete method.
If you are using this method in a DevOps Plan hook
and you are deleting an attachment from the current record (that is,
the record upon which the current action is in progress), then the
entity is already in an editable state. However, if you are using
this method in a hook and deleting an attachment from a record other
than the current entity, or if you are using this method in an external
program, you must first put the entity into editable state by calling
the EditEntity method. See the EditEntity method
for more information.
Syntax
Perl
$attachments->Delete(itemNum);
- Identifier
- Description
- attachments
- An Attachments collection object, representing the set of attachments in one field of a record.
- itemNum
- A Long that is an index into the collection. This index is 0-based and points to the file that you want to delete.
- Return value
- A Boolean that is True if the file was deleted successfully, otherwise False.
Example
Perl
# This example assumes there is at least 1 attachment field in this record type,
# and at least one attachment associated with this record.
# NOTE: The Entity must be in an editable state to delete an attachment -- see above.
# For this entity record, get the collection of all attachment fields
$attachfields = $entity->GetAttachmentFields();
# Work with the first attachment field
$attachfield1 = $attachfields->Item(0);
# For this attachment field, get the collection of all its attachments
$attachments = $attachfield1->GetAttachments();
# Delete the first attachment
if (!$attachments->Delete(0)) {
$session->OutputDebugString("Error deleting attachment from record.\n");
}