Function “hide_data()”

bool hide_data(numeric $gtabid, numeric $ID, string $typ="trash");

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

Parameters:

$gtabid

• Valid table ID: Specifies, along with $ID, the data record to be archived or restored.
• Invalid table ID: Function call is without effect.

$ID

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

$typ

• “archive”: The data record specified with $gtabId and $ID will be archived.
• “trash”: The data record specified with $gtabId and $ID will be put into trash.
• “restore”: The data record specified with $gtabId and $ID will be restored.
• All other values:

Return Value:

• True: The specified data record is in the required state, either archived or restored. Regardless of its state before the function call.
• False: The specified record does not exist or is not in the desired – archived or restored state.