FieldName

Description

Returns the name of the attachment field.

This is a read-only property; it can be viewed but not set. The field name is set using HCL Compass Designer, not the HCL Compass API.

Syntax

VBScript

attachmentField.FieldName 

Perl

$attachmentField->GetFieldName(); 

Identifier

Description

attachmentField

An AttachmentField object representing one attachment field of a record.

Return value

A String containing the name of the field.

Example

VBScript

' This example assumes there is at least 1 attachment field 
' associated with the record. 
set attachFields = entity.AttachmentFields 
set attachField1 = attachFields.Item(0)

name = attachField1.FieldName 

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 field

$attachfield1 = $attachfields->Item(0);



# And retrieve the name of that field

$name = $attachfield1->GetFieldName();