GetFieldStringValueAsList

Description

Returns a list of string values for the specified field.

This method is equivalent to first calling the GetFieldValue method to obtain a FieldInfo object and then calling GetValueAsList method of the FieldInfo object. This is a more direct and more efficient way to get the value of a field.

Note: This method became available in version 2003.06.00.

Syntax

VBScript


entity.GetFieldStringValueAsList field_name 

Perl


$entity->GetFieldStringValueAsList(field_name); 
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 (VBScript only).
field_name
A String that identifies a valid field name of an Entity.
Return value
For VBScript, a 1-element Variant Array is returned. The Variant contains the list of values, separated by vbLF. If the field contains no values, this method returns an Empty Variant.

For Perl, a reference to an array of strings containing the values in the list.

Example

Perl

my $fieldvaluelist = $entity->GetFieldStringValueAsList($fieldname);
# Instead of:
# my $fieldvaluelist = $entity->GetFieldValue($fieldname)->GetValueAsList();