DisplayNameHeader

Description

Returns the unique keys of the attachments in this field.

This is a read-only property; it can be viewed but not set. The unique keys are set using DevOps Plan Designer, not the DevOps Plan Schema API.

Syntax

Perl

$attachmentField->GetDisplayNameHeader(); 

Identifier

Description

attachmentField

An AttachmentField object representing one attachment field of a record.

Return value

A reference to an array of strings.

Example

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

$session = $entity->GetSession();

# Get the collection of attachment fields

$attachfields = $entity->GetAttachmentFields();



# Get the first attachment fields

$attachfield1 = $attachfields->Item(0)



# Get the list of unique keys for identifying each attachment.

$keys = $attachfield1->GetDisplayNameHeader();



# Iterate through the list of keys and print the key value

$x = 0;

foreach $key (@$keys)

 {

 $session->OutputDebugString("Displaying key number".$x." - 
      ".$key);

 $x++;

 }