CommitUpdates Function

This function is called by HotDocs to commit (save) any changes that have been made to fields in the specified record. For example, if a user selects a record and then changes the answers that came from that record, this function is called to update fields in the original record with changed answers.

This function was introduced with the release of HotDocs 2005 SP2. Earlier versions of HotDocs will not call this function.

Syntax

long CommitUpdates ( long lRecordID )

Parameters Description
lRecordID The record identifier (key) for the record to be committed to storage. The record identified by this ID will be in an opened state ready for read/write access.

HotDocs assumes that all record IDs returned by an answer source are greater than or equal to zero. That is, negative record IDs are not allowed.

Return Value

Return HD_SUCCESS (1) if successful, and HD_FAILURE (0) if otherwise.