función TSPI_lineGenerateDigits (tspi.h)

Artículo
08/26/2023

La función TSPI_lineGenerateDigits inicia la generación de los dígitos especificados en la llamada especificada como tonos en banda mediante el modo de señalización especificado. Invocar esta función mientras la generación de dígitos o tonos está en curso anula el dígito o la generación de tono actual. Pasar un valor NULL para lpsDigits no genera nuevos dígitos.

Nota Solo una solicitud de generación en banda a la vez (generación de tono o generación de dígitos) puede estar en curso por llamada.

Sintaxis

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

Parámetros

hdCall

Identificador de la llamada en la que se va a realizar la generación de dígitos.

dwEndToEndID

El proveedor de servicios debe almacenar este identificador de solicitud único y se debe pasar como dwParam2 al procedimiento LINEEVENT cuando se completa la generación de dígitos.

dwDigitMode

Formato que se va a usar para señalar estos dígitos. Este parámetro usa una y solo una de las constantes LINEDIGITMODE_.

lpszDigits

Puntero a un búfer de caracteres Unicode terminado en null que contiene los dígitos que se van a generar. Una coma inserta un retraso adicional entre la señalización de los dígitos anteriores y siguientes que separa. La duración de esta pausa es la configuración definida. Las funcionalidades del dispositivo de la línea indican cuál es esta duración. Se pueden usar varias comas para insertar pausas más largas. Los dígitos no válidos se omiten durante la generación, en lugar de notificarse como un error.

dwDuration

Especifica la duración en milisegundos de dígitos DTMF y espacio entre dígitos DTMF y DTMF. Un valor de 0 usa un valor predeterminado. El parámetro dwDuration debe estar dentro del intervalo especificado por MinDialParams a MaxDialParams en LINEDEVCAPS. Si está fuera del intervalo, el proveedor de servicios establece el valor real en el valor más cercano del intervalo. TAPI no valida este parámetro cuando se llama a esta función.

Valor devuelto

Devuelve cero si la función se realiza correctamente o un número de error si se produce un error. Los valores devueltos posibles son los siguientes:

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

Comentarios

El estado de llamada de hdCall puede ser cualquier estado.

La función TSPI_lineGenerateDigits se considera que se ha completado correctamente cuando se inicia correctamente la generación de dígitos; no cuando se generan todos los dígitos.

Una vez generados todos los dígitos de lpsDigits , o después de que se anule o cancele la generación de dígitos, se enviará un mensaje de LINE_GENERATE a TAPI.

Nota Solo se permite que una solicitud de generación de banda (generación de tono o generación de dígitos) esté en curso por llamada. Esto implica que si la generación de dígitos está actualmente en curso en una llamada, invocando TSPI_lineGenerateDigits o TSPI_lineGenerateTone cancela la generación de dígitos. El proveedor de servicios debe finalizar cualquier generación de dígitos en curso cuando se invoca una TSPI_lineGenerateDigits o TSPI_lineGenerateTone posteriores. La invocación de TSPI_lineGenerateDigits con lpszDigits establecida en NULL cancela cualquier generación de dígitos (o tono) actual.

La función correspondiente en el nivel TAPI no incluye el parámetro formal dwEndToEndID. En ese nivel, no hay ningún marcado de un extremo a otro. TAPI usa el marcado de un extremo a otro en el nivel de TSPI para desambiguar una TSPI_lineGenerateDigits solicitud de otra.