Funzione lineHold (tapi.h)

Articolo
08/26/2023

La funzione lineHold inserisce la chiamata specificata in attesa.

Sintassi

LONG lineHold(
  HCALL hCall
);

Parametri

hCall

Handle per la chiamata da mettere in attesa. L'applicazione deve essere un proprietario della chiamata. Lo stato della chiamata di hCall deve essere connesso.

Valore restituito

Restituisce un identificatore di richiesta positivo se la funzione viene completata in modo asincrono o negativo se si verifica un errore. Il parametro dwParam2 del messaggio di LINE_REPLY corrispondente è zero se la funzione ha esito positivo o è un numero di errore negativo se si verifica un errore. I valori restituiti possibili sono:

LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL, LINEERR_NOTOWNER, LINEERR_UNINITIALIZED.

Commenti

La chiamata in attesa viene temporaneamente disconnessa consentendo all'applicazione di usare il dispositivo line per effettuare o rispondere ad altre chiamate. La funzione lineHold esegue una cosiddetta "hard hold" della chiamata specificata (anziché una "chiamata di consultazione"). In genere non è possibile trasferire o includere una chiamata a una conferenza telefonica, ma una chiamata di consultazione può. Le chiamate di consultazione vengono avviate tramite lineSetupTransfer, lineSetupConference o linePrepareAddToConference.

Dopo che una chiamata è stata messa in attesa, lo stato della chiamata passa in genere a onHold. Una chiamata tenuta viene recuperata da lineUnhold. Mentre una chiamata è in attesa, l'applicazione può ricevere LINE_CALLSTATE messaggi sulle modifiche dello stato della chiamata tenuta. Ad esempio, se la parte bloccata si blocca, lo stato della chiamata può passare a disconnesso.

In una situazione bridged, un'operazione lineHold potrebbe non effettivamente mettere in attesa la chiamata, perché lo stato di altre stazioni sulla chiamata può governare (ad esempio, il tentativo di "tenere" una chiamata quando altre stazioni partecipano non è possibile); In alternativa, la chiamata può essere semplicemente modificata in modalità LINECONNECTEDMODE_INACTIVE se rimane collegata in altre stazioni.