FieldMasks.save (Method)

Saves a field mask.

Returns:

ID (integer)

Arguments:

Name Type Required Description
maskID MaskID_0 Required A mask's ID. If this value is 0, CommonSpot creates a new mask instead of updating an existing mask.
fieldTypeID FieldTypeID Required A field type's ID.
name PlainText_NonNull_255 Required The mask's name.
description PlainText_NonNull_2000 Required The mask's description.
inputModuleType FieldMaskType Required String naming the input module's type, which is either 'Standard' if the mask is in the CommonSpot masks directory or 'Explicit' if you must enter the full path to the input module,.
inputModule ModulePath_EmptyString Required Either the name of a ColdFusion module or the full path to it.
outputModuleType FieldMaskType Required String naming the output module's type, which is either 'Standard' if the mask is in the CommonSpot masks directory or 'Explicit' when you must enter the full path to the output module,.
outputModule ModulePath Required Either the name of a ColdFusion module or the full path to it.
isDefault Boolean Optional. Defaults to '0'. Boolean flag which when set to true indicates that this is the default mask for this field type.

Context:

License Requirements None
Permission Requirements site:ManageFieldTypesMasks
Deny Context None
Require Context AuthoringEnabled
Author Lock (not required)
Transaction Logging If transaction logging is enabled at the site level, calls to this method will be logged
Customization Customization is not supported for this method.

Error Codes:

Code Error Message
18000 Input module '$1' is not valid.
18001 The standard output module is not valid.
18002 Output module $1 is not valid.
18003 Duplicate mask name: $1.
18004 The standard input module is not valid.
18005 MaskID $1 for $2 is not valid.
18007 You cannot set the default value to zero for a default field mask.

Notes:

None