função TSPI_lineGetIcon (tspi.h)

A função TSPI_lineGetIcon recupera um ícone específico do dispositivo de linha de serviço a ser exibido para o usuário.

Sintaxe

LONG TSPIAPI TSPI_lineGetIcon(
  DWORD   dwDeviceID,
  LPCWSTR lpszDeviceClass,
  LPHICON lphIcon
);

Parâmetros

dwDeviceID

O dispositivo de linha 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 ícone específico para essa classe de dispositivo. Esse parâmetro é opcional e pode ser deixado NULL, nesse caso, o ícone de nível mais alto associado ao dispositivo de linha em vez de um dispositivo de fluxo de mídia especificado está selecionado.

As cadeias de caracteres permitidas são iguais às TSPI_lineGetID. Por exemplo, se a linha 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.

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:

LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL, LINEERR_OPERATIONUNAVAIL.

Comentários

O provedor deve retornar um identificador (no DWORD apontado por lphIcon) para um recurso de ícone (obtido do
Função LoadIcon ) associada à linha especificada.

Um provedor pode optar por dar suporte a muitos ícones (selecionados por lpszDeviceClass e/ou número de linha), um único ícone (como para o fabricante, que seria retornado para todas as solicitações TSPI_lineGetIcon 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 genérico de Telefonia (o ícone genérico de "linha").

Requisitos

Plataforma de Destino	Windows
Cabeçalho	tspi.h

Confira também

TSPI_lineConfigDialog

Tspi_linegetid