função TSPI_phoneGetID (tspi.h)
A função TSPI_phoneGetID retorna um identificador de dispositivo para a classe de dispositivo especificada associada ao dispositivo de telefone especificado.
Sintaxe
LONG TSPIAPI TSPI_phoneGetID(
HDRVPHONE hdPhone,
LPVARSTRING lpDeviceID,
LPCWSTR lpszDeviceClass,
HANDLE hTargetProcess
);
Parâmetros
hdPhone
O identificador para o telefone a ser consultado.
lpDeviceID
Um ponteiro para uma estrutura de dados do tipo VARSTRING em que o identificador do dispositivo é retornado. O formato das informações retornadas depende do método usado pela API (classe de dispositivo) para nomear dispositivos. Antes de chamar TSPI_phoneGetID, o aplicativo define o membro dwTotalSize dessa estrutura para indicar a quantidade de memória disponível para TAPI para retornar informações.
lpszDeviceClass
Um ponteiro para uma cadeia de caracteres Unicode terminada em nulo que especifica a classe de dispositivo do dispositivo cujo identificador é solicitado.
hTargetProcess
O identificador de processo do aplicativo em nome do qual a função TSPI_phoneGetID está sendo invocada. Se as informações que estão sendo retornadas na estrutura VARSTRING incluirem um identificador para uso pelo aplicativo, o provedor de serviços criará ou duplicará o identificador do processo.
Retornar valor
Retornará zero se a função for bem-sucedida ou um número de erro se ocorrer um erro. Os possíveis valores retornados são os seguintes:
PHONEERR_INVALPHONEHANDLE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALDEVICECLASS, PHONEERR_OPERATIONFAILED, PHONEERR_NOMEM, PHONEERR_OPERATIONUNAVAIL.
Comentários
Essa operação pode ser usada para recuperar um identificador de dispositivo de telefone dado um identificador de telefone. Ele também pode ser usado para obter o identificador de dispositivo do dispositivo de mídia (para classes de dispositivo como COM, wave, MIDI, telefone, linha e mciwave) associado ao dispositivo de telefone aberto. Esse identificador pode ser usado com a API de mídia apropriada (como mci, midi e wav) para selecionar o dispositivo correspondente. Para obter mais informações sobre nomes comuns de classe de dispositivo, consulte Classes de dispositivo TSPI.
O provedor de serviços preenche todos os membros da estrutura de dados VARSTRING , exceto dwTotalSize, que é preenchido pelo TAPI. O provedor de serviços não deve substituir o membro dwTotalSize .
O provedor de serviços não precisa se preocupar com o tratamento de classes de dispositivo tapi/line e tapi/phone, pois o TAPI manipula essas classes para o provedor de serviços. Portanto, o código para lidar com essas classes de dispositivo é opcional.
Requisitos
| Requisito | Valor |
|---|---|
| Plataforma de Destino | Windows |
| Cabeçalho | tspi.h |