DisplayName

Description

Returns the unique key used to identify the attachment. This is a read-only property; it can be viewed but not set.

The unique key is a concatenation of the file name, file size, description, and database ID, each delimited by a newline (\n) character.

Syntax

VBScript

attachment.DisplayName 

Perl

$attachment->GetDisplayName(); 

Identifier

Description

attachment

An Attachment object, representing the attachment of a file to a record.

Return value

A String containing the unique key.

Example

VBScript

' This example assumes there is at least 1 attachment field
' and 1 attachment associated with the record.
set currentSession = GetSession
set attachFields = AttachmentFields
set attachField1 = attachFields.Item(0)
set theAttachments = attachField1.Attachments
For each attachment in theAttachments
    theDescription = attachment.Description
    key = attachment.DisplayName
    currentSession.OutputDebugString "Unique key: " & key & _
        " - description: " & theDescription
Next

Perl

# This example assumes that there is at least 1 attachment
# field associated with the record. Otherwise, 
# GetAttachmentFields won't return anything interesting and an 
# error would be generated

# Get the collection of attachment fields
$attachfields = $entity->GetAttachmentFields();

# Get the first attachment fields
$attachfield1 = $attachfields->Item(0)

# Now get the collection of attachments from the attachments field
$attachments = $attachfield1->GetAttachments();

# Retrieve the number of attachments for the for loop
$numattachments = $attachments->Count();

for ($x = 0 ; $x < $numattachments ; $x++)
 {
 # Retrieve the correct attachment
 $attachment = $attachments->Item($x);
     # Get the unique attachment key and the attachment description 
     # and print it out
 $description = $attachment->GetDescription();
 $key = $attachment->GetDisplayName();
 $session->OutputDebugString("Unique key: ".$key." - description:
          ".$description);
 }