GetFieldsUpdatedThisSetValue
Description
Returns a FieldInfo object for each of the Entity's fields that was modified by the most recent SetFieldValue call.
This method usually returns
a single FieldInfo object for the field that was modified by SetFieldValue.
However, this method can return multiple FieldInfo objects if other fields
are dependent on the field that was changed. In such a case, hook code could
automatically modify the value of any dependent fields, causing them to be
modified as well and thus reported by this method.
Syntax
Perl
$entity->GetFieldsUpdatedThisSetValue();
- 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 FieldInfos Object collection is returned.
Example
Perl
$entity->SetFieldValue("field1", "100");
$modifiedfields = $entity->GetFieldsUpdatedThisSetValue();
$numfields = $modifiedfields->Count();
if ($numfields > 1)
{
$session->OutputDebugString("Changing field1 resulted in changes
to ".$numfields." other fields");
}