.UTIL FIELD SET

This subroutine is called to set a value into a specified field name.

Usage:

      PASS         <App_Id>                   FIELD            SHARE? N
      PASS         <Field_Name>               FIELD            SHARE? N
      PASS         <Occ_no>                   FIELD            SHARE? N
      PASS         <value>                    FIELD            SHARE? N
      GOSUB    --- .UTIL FIELD SET
      *        Check for errors
      IF       --- .UTIL FIELD SET            NE

Description:

This subroutine is called to set a value into a specified field name. All parameters are required. If any required parameters are missing, the subroutine will CANCEL.

<App_Id> is the Application Id of the field you want to set (Required). The version will be taken from the currently running version.

<Field_Name> is the field you want to set (Required). This must be a valid field in the specified application.

<Occ_no> is the occurrence number (Required). If blank or zero, it will default to 1.

<value> is the string of data you want to set into the specified field (Required).

<value> must be appropriate for the type of field. For example, if the target field is an unsigned integer, then you cannot set real or negative numbers into it. If the value is too large, too small or has too many decimal places for the target field, it will not be set. If the target field is a token, you must pass a valid token value (case sensitive). Date/time fields must be a string in the format CCYYMMDDhhmmsstt. If any leading parts are not supplied, they must be replaced with a dash character, ie, '--120228' or '--------2241'. Trailing dashes are optional. If the data cannot be moved into the target field, the previous contents of the target field will remain unchanged.

Note: During debugging you will not be able to inspect the contents (via F11) of a field referenced using this API unless your process also has a reference in ILF to either the specific field (ie, a DISPLAY statement) or to the file containing the field (ie, READ/WRITE, etc) or to some other field in the same file (if the field is part of a file and not a work field).

See also .UTIL FIELD GET.

Comments:

Read what other users have said about this page or add your own comments.

-- JeanNeron - 2012-02-22