EditAttachmentFieldDescription
Description
Updates the description field of the given attachment. Changes the attachment's description to the new value.
Note: This method became available in version 2002.05.00.
Syntax
VBScript
entity.EditAttachmentFieldDescription attachment_fieldname,
element_displayname, new_description
Perl
$entity->EditAttachmentFieldDescription(attachment_fieldname,
element_displayname, new_description);
- Identifier
- Description
- entity
- An Entity object representing a user data record. Inside a hook, if you omit this part of the syntax, the Entity object corresponding to the current data record is assumed.
- attachment_fieldname
- A String containing the attachment field name for which you are editing the field description.
- element_displayname
- A String containing the attachment file name.
- new_description
- A String containing the new description of the attachment.
- Return value
- Returns a String. The String returned is empty if the update is permitted, or an explanation of the error.