9 75 DOM_UPDATE_FIELD

LANSA Technical

9.75 DOM_UPDATE_FIELD

Þ Note: Built-In Function Rules.

Updates an existing field to an open data note using the field name. The field type must also be specified.  If the field does not exist it will be added to the document.

The field types supported are the simple data types TYPE_TEXT,  TYPE_NUMBER, TYPE_TIME and TYPE_TEXT_LIST as these are the closest types to the standard LANSA data types A (Alphanumeric), P (Packed) and S (Signed). The data will be converted to the required field type and from EBCDIC to LMBCS for TYPE_TEXT,  TYPE_DATE and TYPE_TEXT_LIST fields.

Either an alphanumeric field value or numeric field value should be specified to update the specified field.  For a TYPE_TIME field, the alphanumeric value may be specified as '*CURRENT', in which case the current date and time will be set for the field otherwise the date/time value must be supplied in the correct format e.g. mm/dd/yy hh:mm:ss. For a TYPE_TEXT_LIST field, the value will be added to the existing field if the text list field already exists.

Note that the document/data note is not updated in the database until you use the DOM_UPDATE_DOCUMENT Built-In Function.

For use with

LANSA for i

YES

Visual LANSA for Windows

YES

Visual LANSA for Linux

NO

 

 

Arguments

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Document/Data Note handle

4

4

 

 

2

A

Req

Field name to be updated in the document

1

65

 

 

3

N

Req

Field type in note:

1 = TYPE_NUMBER

2 = TYPE_TEXT

3 = TYPE_TIME

4 = TYPE_TEXT_LIST

1

7

0

0

4

A

Opt

Alphanumeric field required for field type TYPE_TEXT, TYPE_TIME & TYPE_TEXT_LIST

1

256

 

 

5

N

Opt

Numeric field required for field type TYPE_NUMBER

1

15

0

9

 

 

Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Return code

OK = Field successfully updated.

ER = Field not updated.

2

2

 

 

 

 

Example

Refer to this Domino Built-In Function Example:

Example 4: Updating Documents selected from a Browselist

Technical Notes

This Built-In Function uses the standard Lotus Notes APIs NSFFieldSetNumber, NSFFieldSetText, ConvertTextToTIMEDATE, NSFFieldSetTime and NSFFieldAppendTextList. All security and integrity issues related to the use of this Built-In Function are according to normal Lotus Notes API use for the current platform.