TSPI_phoneGetButtonInfo función (tspi.h)

Artículo
03/03/2024

La función TSPI_phoneGetButtonInfo devuelve información sobre un botón especificado.

Sintaxis

LONG TSPIAPI TSPI_phoneGetButtonInfo(
  HDRVPHONE         hdPhone,
  DWORD             dwButtonLampID,
  LPPHONEBUTTONINFO lpButtonInfo
);

Parámetros

hdPhone

Identificador del teléfono que se va a consultar.

dwButtonLampID

Un botón en el dispositivo telefónico.

lpButtonInfo

Puntero a la memoria en la que el proveedor de servicios escribe una estructura de tamaño variable de tipo PHONEBUTTONINFO. Esta estructura de datos describe el modo y la función, y proporciona texto descriptivo adicional correspondiente al botón. Antes de llamar a TSPI_phoneGetButtonInfo, la aplicación establece el miembro dwTotalSize de esta estructura para indicar la cantidad de memoria disponible para TAPI para devolver informació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:

PHONEERR_INVALPHONEHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALBUTTONLAMPID, PHONEERR_OPERATIONUNAVAIL, PHONEERR_INVALPHONESTATE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_NOMEM.

Comentarios

La función TSPI_phoneGetButtonInfo devuelve el valor PHONEERR_NOMEM si el proveedor de servicios no puede acceder a la memoria que contiene la información del botón.

El proveedor de servicios rellena todos los miembros de la estructura de datos PHONEBUTTONINFO , excepto dwTotalSize, que tapi rellena. El proveedor de servicios no debe sobrescribir el miembro dwTotalSize .