説明
指定された値を、指定されたフィールドの値のリストに追加します。
このメソッドは SetFieldValue と似ています。ただし、単独の値を指定する代わりに、アイテムを値のリストに追加するのを除きます。このメソッドは、値のリストを受け入れ可能なフィールドを意図しています。
フィールドにまだ値が格納されていない場合、このメソッドをそのまま使用して単一値を使用するフィールドの値を設定できます。
注: AddFieldValue メソッドは、リスト フィールドを操作することを意図しています。
スカラ フィールド (文字列、複数行文字列、参照など) を操作することは意図していません。
フィールドに有効な値が格納されているかどうか判別するには、そのフィールドの FieldInfo オブジェクトを取得し、FieldInfo オブジェクトの ValidityChangedThisSetValue を呼び出して、フィールドを検証します。
このメソッドは、Entity オブジェクトが編集可能な場合にのみ呼び出すことができます。既存の Entity オブジェクトを編集可能にするには、Session オブジェクトの EditEntity を呼び出します。
構文
VBScript
entity.AddFieldValue field_name, new_value
Perl
$entity->AddFieldValue(field_name, new_value);
- 識別子
- 説明
- entity
- Entity オブジェクトは、ユーザー データ レコードを表します。構文のこの部分を省略すると、フック内では、現在のデータ レコードに対応する Entity オブジェクトが想定されます。
- field_name
- この Entity オブジェクトの有効なフィールド名を含む String。
- new_value
- Visual Basic の場合、フィールドに追加する新規の値を含む Variant。Perl の場合は、新規の値を含む文字列。
- 戻り値
- フィールドへの変更が許可されている場合、このメソッドは空の文字列を戻します。それ以外の場合、このメソッドは、エラーの説明を含む文字列を戻します。
例
VBScript
AddFieldValue "field1", "option 1"
AddFieldValue "field1", "option 2"
AddFieldValue "field1", "option 3"
Perl $entity->AddFieldValue("field1", "option 1");
$entity->AddFieldValue("field1", "option 2"); $entity->AddFieldValue("field1",
"option 3");