funzione TSPI_lineGenerateDigits (tspi.h)

Articolo
08/26/2023

La funzione TSPI_lineGenerateDigits avvia la generazione delle cifre specificate nella chiamata specificata come toni in banda usando la modalità di segnalazione specificata. Richiamando questa funzione mentre la generazione di cifre o toni è in corso interrompe la generazione corrente di cifre o toni. Il passaggio di un valore NULL per lpsDigits non genera nuove cifre.

Nota Una sola richiesta di generazione in banda alla volta (generazione di tono o generazione di cifre) può essere in corso per ogni chiamata.

Sintassi

LONG TSPIAPI TSPI_lineGenerateDigits(
  HDRVCALL hdCall,
  DWORD    dwEndToEndID,
  DWORD    dwDigitMode,
  LPCWSTR  lpszDigits,
  DWORD    dwDuration
);

Parametri

hdCall

Handle per la chiamata alla generazione di cifre da eseguire.

dwEndToEndID

Questo identificatore di richiesta univoco deve essere archiviato dal provider di servizi e passato come dwParam2 alla procedura LINEEVENT al termine della generazione di cifre.

dwDigitMode

Formato da utilizzare per segnalare queste cifre. Questo parametro usa una e solo una delle costanti LINEDIGITMODE_.

lpszDigits

Puntatore a un buffer di caratteri Unicode con terminazione null contenente le cifre da generare. Una virgola inserisce un ritardo aggiuntivo tra il segnale del precedente e le cifre successive separate. La durata di questa pausa è definita dalla configurazione. Le funzionalità del dispositivo della linea indicano qual è la durata. È possibile usare più virgole per inserire pause più lunghe. Le cifre non valide vengono ignorate durante la generazione, anziché essere segnalate come errore.

dwDuration

Specifica sia la durata in millisecondi delle cifre DTMF e della spaziatura tra cifre DTMF e DTMF. Un valore pari a 0 usa un valore predefinito. Il parametro dwDuration deve trovarsi all'interno dell'intervallo specificato da MinDialParams a MaxDialParams in LINEDEVCAPS. Se non è compreso nell'intervallo, il valore effettivo viene impostato dal provider di servizi sul valore più vicino nell'intervallo. Questo parametro non viene convalidato da TAPI quando questa funzione viene chiamata.

Valore restituito

Restituisce zero se la funzione ha esito positivo o un numero di errore se si verifica un errore. I valori restituiti possibili sono i seguenti:

LINEERR_INVALCALLHANDLE, LINEERR_NOMEM, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALDIGITMODE, LINEERR_OPERATIONFAILED, LINEERR_RESOURCEUNAVAIL, LINEERR_RESOURCEUNAVAIL.

Commenti

Lo stato della chiamata di hdCall può essere qualsiasi stato.

La funzione TSPI_lineGenerateDigits viene considerata completata correttamente quando la generazione di cifre viene avviata correttamente; non quando vengono generate tutte le cifre.

Dopo che tutte le cifre in lpsDigits vengono generate o dopo l'interruzione della generazione di cifre o annullate, viene inviato un messaggio di LINE_GENERATE a TAPI.

Nota Per ogni chiamata è consentita una sola richiesta di generazione inband (generazione di tono o generazione di cifre). Ciò implica che se la generazione di cifre è attualmente in corso su una chiamata, richiamando TSPI_lineGenerateDigits o TSPI_lineGenerateTone annulla la generazione di cifre. Il provider di servizi deve terminare qualsiasi generazione di cifre in corso quando viene richiamata una TSPI_lineGenerateDigits successiva o TSPI_lineGenerateTone . Richiamando TSPI_lineGenerateDigits con lpszDigits impostato su NULL annulla qualsiasi generazione di cifre correnti (o tono).

La funzione corrispondente a livello TAPI non include il parametro formale dwEndToEndID. A questo livello non esiste alcun contrassegno end-to-end. TAPI usa il contrassegno end-to-end a livello TSPI per disambiguare una richiesta di TSPI_lineGenerateDigits da un'altra.