HandsetOnHook

Purpose

This function returns the status of the local handset. This is the handset connected to the phone jack on the modem device.

Parameters

Parameter: Line
Type: Integer
Description: The phone line to access.

Returns

Return value: Status of line
Type: Boolean
Description: Return TRUE if the local handset is on-hook (not in use) or FALSE if the handset is off-hook (in use).

Examples

dim hook_stat

hook_stat = hsp.HandsetOnHook(1)