Function “lock_data()”

Estimated reading: 1 minute
bool lock_data(numeric $gtabid, numeric $ID, array &$gresult=null);

Function to lock a data record (./limbas_src/gtab/gtab.lib).

Parameters:

$gtabid

  • Valid table ID: Specifies, along with $ID, the data record to be locked. It is only possible to lock a data record if the appropriate option for the specified table is enabled in the Table Settings.
  • Invalid table ID: Function call is without effect.

$ID

  • Valid data record ID: Specifies, along with $gtabId, the data record to be locked.
  • Invalid data record ID: Function call is without effect.

&$gresult

  • Zero: The database query for the specified data record is executed within the function.
  • If, when calling the function, the result of the database query is available for the specified data record, it makes sense, for performance reasons, to transfer it to the function.

Return Value:

  • True: The data record has been locked or the data record could not be locked because the appropriate option for the specified table is not enabled in the Table Settings.
  • False: The data record could not be locked, even though appropriate option for the specified table is enabled in the Table Settings.