PIC_ValidateField

Validates the format of the current field by using the picture string that is stored in the PictureString variable of the field.

Syntax

bool PIC_ValidateField ()

Parameters

None.

Returns

False if the field value does not satisfy the Picture String criteria of the field. Otherwise True.

Level

Field level only.

Details

Checks the value of all characters in a field against that field's PictureString criteria.

If a character in the field does not match the picture string format defined for that field, it lowers the Confidence Rating of any character in a field that does not satisfy the Picture String's criteria. The criteria is stored in the PictureString variable that is bound to the field.

Note: Fields with a status of '-1' (Hidden) are checked but this action will not return false if the value does not match the picture string criteria.

While not direct input parameters to this action, this action works with picture strings that are defined for a field. See the PIC_FormatFields action for a list of all available picture string codes and information about the PictureString variable.

Example
PIC_ValidateField()