HistoryFields

Description

Returns the HistoryFields collection object containing this Entity object's history fields.

This property is read-only; you cannot modify this field programmatically. For an overview of history objects, see History Object.

Syntax

VBScript

entity.HistoryFields 

Perl

$entity->GetHistoryFields(); 

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.

Return value

A HistoryFields Object that contains all the individual HistoryField objects currently associated with this Entity object.

Examples

VBScript

set fields = entity.HistoryFields 
For Each fieldObj in fields 
   ' Look at the contents of the HistoryField object 

   ' ... 
Next 

Perl

# Get the list of history fields

$historyfields = $entity->GetHistoryFields();



# Find out how many history fields there

# are so the for loop can iterate them

$numfields = $historyfields->Count();



for ($x = 0; $x < $numfields ; $x++)

 {

 # Get each history field

 $onefield = $historyfields->Item($x);



 # ...do some work with $onefield

 }