peoplecodeapi - SetDBFieldCharDefn

SetDBFieldCharDefn(Field.FieldName, Length [, FormatFamily])

Use the SetDBFieldCharDefn function to create a field definition of type character, with the indicated name, length, and format family.

Note: After using this function, you should use the SetDBFieldLabel function to define the label for the new field.

Field or Control	Definition
`Fieldname`	Specify the name of the new field that you want to create. This name must be prefixed by the reserved word Field .
`Length`	Specify the length of the new field as a number.
`FormatFamily`	Specify the format family of the new field. This parameter is optional: the default value is upper case. The valid values are: %FormatFamilyType_Upper (default) %FormatFamilyType_Name %FormatFamilyType_Phone %FormatFamilyType_Zip %FormatFamilyType_SSN %FormatFamilyType_MixedCase %FormatFamilyType_NumOnly %FormatFamilyType_SIN %FormatFamilyType_PhoneIntl %FormatFamilyType_ZipIntl

Field or Control

Definition

Fieldname

Specify the name of the new field that you want to create. This name must be prefixed by the reserved word Field .

Length

Specify the length of the new field as a number.

FormatFamily

Specify the format family of the new field. This parameter is optional: the default value is upper case. The valid values are:

A constant value. The values are:

Value	Description
%MDA_Success	Bulk operation completed successfully.
%MDA_Failure	Bulk operation did not complete successfully.
%MDA_Duplicate	The field specified by `FieldName` already exists.
%MDA_FieldFmtLength	The specified length conflicts with the specified format family and was overwritten when the field was created.