Função lineGetAppPriority (tapi.h)

Artigo
08/26/2023

A função lineGetAppPriority permite que um aplicativo determine se ele está ou não na lista de prioridades de entrega para um modo de mídia específico ou modo de solicitação de telefonia assistida e, nesse caso, sua posição na lista de prioridades.

Sintaxe

LONG lineGetAppPriority(
  LPCSTR            lpszAppFilename,
  DWORD             dwMediaMode,
  LPLINEEXTENSIONID lpExtensionID,
  DWORD             dwRequestMode,
  LPVARSTRING       lpExtensionName,
  LPDWORD           lpdwPriority
);

Parâmetros

lpszAppFilename

Um ponteiro para uma cadeia de caracteres que contém o nome do arquivo do módulo executável do aplicativo, sem dados de diretório. Na versão 2.0 ou posterior da API, o parâmetro pode estar no formato de nome de arquivo longo, do qual o formato de nome de arquivo 8.3 é um subconjunto adequado. Nomes de arquivo longos, ao contrário dos nomes de arquivo 8.3, são preservação de maiúsculas e minúsculas. Nenhum formato de nome de arquivo diferencia maiúsculas de minúsculas. Para obter mais informações, consulte Convenções de Nome de Arquivo. Em versões de API anteriores à 2.0, o parâmetro deve especificar um nome de arquivo no formato 8.3; nomes de arquivo longos não podem ser usados.

dwMediaMode

Um modo de mídia para o qual os dados de prioridade devem ser obtidos. O valor pode ser uma das constantes LINEMEDIAMODE_; apenas um único bit pode estar ativado. O valor 0 deve ser usado se estiver verificando a prioridade do aplicativo para solicitações de telefonia assistida.

lpExtensionID

Um ponteiro para a estrutura do tipo LINEEXTENSIONID. Este parâmetro é ignorado.

dwRequestMode

As condições para esse parâmetro são, se o parâmetro dwMediaMode for zero, esse parâmetro especificará o modo de solicitação de telefonia assistida para o qual a prioridade deve ser verificada. Deve ser LINEREQUESTMODE_MAKECALL. Esse parâmetro será ignorado se dwMediaMode não for zero.

lpExtensionName

Este parâmetro é ignorado.

lpdwPriority

Um ponteiro para um local de memória do tamanho DWORD no qual o TAPI grava a prioridade do aplicativo para o modo de mídia ou solicitação especificado. O valor 0 será retornado se o aplicativo não estiver na lista de prioridades armazenada e não tiver nenhum dispositivo de linha aberto com a propriedade solicitada do modo de mídia especificado ou se tiver registrado para o modo de solicitação especificado.

Em versões de API anteriores à 2.0, o valor –1 (0xFFFFFFFF) será retornado se o aplicativo tiver a linha aberta para o modo de mídia especificado ou tiver se registrado para as solicitações especificadas, mas o aplicativo não estiver na lista de prioridades armazenadas; ou seja, ele está apenas na lista de prioridades temporárias. Na versão 2.0 ou posterior da API, o valor 0 é retornado para indicar essa condição.

Caso contrário, o valor indica a posição do aplicativo na lista; 1 sendo a prioridade mais alta e aumentando os valores que indicam a prioridade decrescente.

Retornar valor

Retornará zero se a solicitação for bem-sucedida ou um número de erro negativo se ocorrer um erro. Os possíveis valores retornados são:

LINEERR_INIFILECORRUPT, LINEERR_INVALREQUESTMODE, LINEERR_INVALAPPNAME, LINEERR_NOMEM, LINEERR_INVALMEDIAMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL.

Comentários

Se LINEERR_INVALMEDIAMODE for retornado, o valor especificado em dwMediaMode não será zero, não será um modo de mídia estendido válido e não uma das constantes LINEMEDIAMODE_ ou mais de um bit estará ativado no valor do parâmetro.