Copyright © Cloud Software Group, Inc. All Rights Reserved

openform_set_field_value()

Set the value for a iProcess field in the given form session.

Synopsis

C/C++

long int openform_set_field_value (long int openform_id, long int sal_formsh, LPSTR lpfield_name, LPSTR lpfield_value)

VB

Function openform_set_field_value (openform_id As Long, sal_formsh As Long, lpfield_name As String, lpfield_value As String) As Long

where:

•	openform_id is the identifier of the Open Forms SDK Interface Function module, as returned by openform_initialise().

•	sal_formsh is the SAL form session handle that identifies the work item, as passed to your Open Form application by the calling script. See Creating the Script to Call the Open Forms Application.

•	lpfield_name is the name of the iProcess field that you want to set the value of.

•	lpfield_value is the value you want to assign to the field. You must ensure that this value is appropriate for the iProcess field type.

For example, if lpfield_name is a iProcess date then lpfield_value must be a valid iProcess date string (as defined in the SWDIR\etc\staffcfg file.)

Description

Use this function to set the value of an iProcess field for the work item associated with the given form session.

Note that:

•	Most iProcess system fields (SW_xxx) are read only and cannot be changed using openform_set_field_value(). If you try to change a system field the call is simply ignored. No error is returned.

•	It is more efficient to pass only field values that have actually changed back to iProcess. (This is because any field value that is returned by openform_set_field_value() is flagged by iProcess as changed - even if its value is the same - and passed to and from the iProcess Engine.)

Returns

One of the following numeric values.

Value	Description
1	Success.
0	Invalid openform_id.
-1	Invalid sal_formsh.
-2	Invalid lpfield_name.
-4	np_sal_frm_getdata interface() function not available.

 

Copyright © Cloud Software Group, Inc. All Rights Reserved