função TSPI_phoneGetIcon (tspi.h)
A função TSPI_phoneGetIcon recupera um ícone específico do dispositivo de telefone de serviço (ou específico do provedor) a ser exibido para o usuário.
Sintaxe
LONG TSPIAPI TSPI_phoneGetIcon(
DWORD dwDeviceID,
LPCWSTR lpszDeviceClass,
LPHICON lphIcon
);
Parâmetros
dwDeviceID
O dispositivo de telefone cujo ícone é solicitado.
lpszDeviceClass
Um ponteiro para uma cadeia de caracteres Unicode terminada em nulo que identifica um nome de classe de dispositivo. Essa classe de dispositivo permite que o chamador selecione um subconícone específico aplicável a essa classe de dispositivo. Esse parâmetro é opcional e pode ser deixado NULL ou estar vazio, nesse caso, o ícone de nível mais alto associado ao dispositivo de telefone em vez de um dispositivo de fluxo de mídia especificado está selecionado.
lphIcon
Um ponteiro para um local de memória no qual o identificador para o ícone é retornado.
Valor retornado
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_INVALDEVICECLASS, PHONEERR_OPERATIONFAILED, PHONEERR_NOMEM, PHONEERR_OPERATIONUNAVAIL, PHONEERR_RESOURCEUNAVAIL.
Comentários
TSPI_phoneGetIcon faz com que o provedor retorne um identificador (no DWORD apontado por lphIcon) para um recurso de ícone (obtido do
Função LoadIcon ) associada ao telefone especificado. O identificador de ícone é para um recurso associado ao provedor.
O parâmetro lpszDeviceClass permite que o provedor retorne ícones diferentes com base no tipo de serviço que está sendo referenciado pelo chamador. As cadeias de caracteres permitidas são iguais às TSPI_phoneGetID. Por exemplo, se o telefone der suporte à API comm, passar comm/datamodem como lpszDeviceClass fará com que o provedor retorne um ícone relacionado especificamente às funções de dispositivo Comm do provedor de serviços. Para obter mais informações sobre classes de dispositivo comuns, consulte Classes de dispositivo TSPI.
Os parâmetros "tapi/phone", "" ou NULL podem ser usados para solicitar o ícone do dispositivo de telefone. Um provedor pode optar por dar suporte a muitos ícones (selecionados por lpszDeviceClass e/ou número de telefone), um único ícone (como para o fabricante, que seria retornado para todas as solicitações phoneGetIcon independentemente do lpszDeviceClass selecionado) ou nenhum ícone, nesse caso, ele define o DWORD apontado por lphIcon como NULL. O TAPI examina o identificador retornado pelo provedor e, se o provedor retornar NULL, o TAPI substituirá um ícone de telefonia genérico incluído como um recurso no TAPI (o ícone de telefone genérico).
Se o provedor de serviços não der suporte a nenhum ícone, ele poderá deixar essa função sem simplificação; nesse caso, o TAPI fornece um ícone de telefone genérico para o aplicativo.
Requisitos
| Plataforma de Destino | Windows |
| Cabeçalho | tspi.h |