Funzione lineGetAppPriority (tapi.h)

Articolo
08/26/2023

La funzione lineGetAppPriority consente a un'applicazione di determinare se si trova o meno nell'elenco di priorità di handoff per una particolare modalità multimediale o per la modalità richiesta di telefonia assistita e, in tal caso, la relativa posizione nell'elenco di priorità.

Sintassi

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

Parametri

lpszAppFilename

Puntatore a una stringa contenente il nome del file del modulo eseguibile dell'applicazione, senza dati di directory. Nella versione 2.0 o successiva dell'API il parametro può essere in formato di nome file lungo, di cui il formato del nome file 8.3 è un subset corretto. I nomi di file lunghi, a differenza dei nomi di file 8.3, conservano le maiuscole e minuscole. Nessuno dei due formati di nome file fa distinzione tra maiuscole e minuscole. Per altre informazioni, vedere Convenzioni dei nomi file. Nelle versioni API precedenti alla 2.0, il parametro deve specificare un nome file nel formato 8.3; non è possibile utilizzare nomi di file lunghi.

dwMediaMode

Modalità multimediale per cui ottenere i dati prioritari. Il valore può essere una delle costanti LINEMEDIAMODE_; solo un bit singolo può essere attivato. Il valore 0 deve essere usato se si verifica la priorità dell'applicazione per le richieste di telefonia assistita.

lpExtensionID

Puntatore alla struttura di tipo LINEEXTENSIONID. Questo parametro viene ignorato.

dwRequestMode

Le condizioni per questo parametro sono, se il parametro dwMediaMode è zero, questo parametro specifica la modalità richiesta di telefonia assistita per la quale deve essere verificata la priorità. Deve essere LINEREQUESTMODE_MAKECALL. Questo parametro viene ignorato se dwMediaMode è diverso da zero.

lpExtensionName

Questo parametro viene ignorato.

lpdwPriority

Puntatore a una posizione di memoria di dimensioni DWORD in cui TAPI scrive la priorità dell'applicazione per il supporto o la modalità richiesta specificata. Il valore 0 viene restituito se l'applicazione non è presente nell'elenco di priorità archiviato e attualmente non dispone di alcun dispositivo line aperto con la proprietà richiesta della modalità supporto specificata o di aver registrato per la modalità richiesta specificata.

Nelle versioni dell'API precedenti alla 2.0, il valore –1 (0xFFFFFFFF) viene restituito se l'applicazione ha la riga aperta per la modalità supporto specificata o ha registrato per le richieste specificate, ma l'applicazione non è nell'elenco di priorità archiviato; vale a dire, si trova solo nell'elenco di priorità temporanea. Nella versione 2.0 o successiva dell'API viene restituito il valore 0 per indicare questa condizione.

In caso contrario, il valore indica la posizione dell'applicazione nell'elenco; 1 è la priorità più alta e i valori crescenti indicano una priorità decrescente.

Valore restituito

Restituisce zero se la richiesta ha esito positivo o negativo se si verifica un errore. I valori restituiti possibili sono:

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

Commenti

Se viene restituito LINEERR_INVALMEDIAMODE, il valore specificato in dwMediaMode non è zero, non una modalità multimediale estesa valida e non una delle costanti LINEMEDIAMODE_ o più bit sono attiva nel valore del parametro.