lineGetAppPriority-Funktion (tapi.h)

Artikel
03/06/2024

Mit der lineGetAppPriority-Funktion kann eine Anwendung ermitteln, ob sie sich in der Übergabeprioritätsliste für einen bestimmten Medienmodus oder den Anforderungsmodus für unterstützte Telefonie befindet oder nicht und, wenn ja, ihre Position in der Prioritätsliste.

Syntax

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

Parameter

lpszAppFilename

Ein Zeiger auf eine Zeichenfolge, die den Dateinamen des ausführbaren Moduls der Anwendung ohne Verzeichnisdaten enthält. In API-Version 2.0 oder höher kann der Parameter ein langes Dateinamenformat aufweisen, von dem das Dateinamenformat 8.3 eine richtige Teilmenge ist. Lange Dateinamen, im Gegensatz zu 8.3-Dateinamen, behalten die Groß- und Kleinschreibung bei. Bei keinem Dateinamenformat wird die Groß-/Kleinschreibung beachtet. Weitere Informationen finden Sie unter Dateinamenkonventionen. In API-Versionen vor 2.0 muss der Parameter einen Dateinamen im Format 8.3 angeben. Lange Dateinamen können nicht verwendet werden.

dwMediaMode

Ein Medienmodus, für den die Prioritätsdaten abgerufen werden sollen. Der Wert kann eine der LINEMEDIAMODE_ Konstanten sein. es kann nur ein einzelnes Bit aktiviert sein. Der Wert 0 sollte verwendet werden, wenn die Anwendungspriorität für Anforderungen der unterstützten Telefonie überprüft wird.

lpExtensionID

Ein Zeiger auf die Struktur vom Typ LINEEXTENSIONID. Konvertiert die Zeichenfolgendarstellung einer Zahl in einem angegebenen Stil und einem kulturspezifischen Format in die entsprechende 32-Bit-Ganzzahl mit Vorzeichen.

dwRequestMode

Die Bedingungen für diesen Parameter sind, wenn der dwMediaMode-Parameter 0 ist, gibt dieser Parameter den Anforderungsmodus für unterstützte Telefonie an, für den die Priorität überprüft werden soll. Sie muss LINEREQUESTMODE_MAKECALL werden. Dieser Parameter wird ignoriert, wenn dwMediaMode ungleich 0 ist.

lpExtensionName

Konvertiert die Zeichenfolgendarstellung einer Zahl in einem angegebenen Stil und einem kulturspezifischen Format in die entsprechende 32-Bit-Ganzzahl mit Vorzeichen.

lpdwPriority

Ein Zeiger auf einen Speicherspeicherort der DWORD-Größe, in den TAPI die Priorität der Anwendung für den angegebenen Medien- oder Anforderungsmodus schreibt. Der Wert 0 wird zurückgegeben, wenn sich die Anwendung nicht in der gespeicherten Prioritätsliste befindet und derzeit kein Zeilengerät geöffnet ist, das den Besitz des angegebenen Medienmodus angefordert hat oder für den angegebenen Anforderungsmodus registriert ist.

In API-Versionen vor 2.0 wird der Wert –1 (0xFFFFFFFF) zurückgegeben, wenn die Anwendung die Zeile für den angegebenen Medienmodus geöffnet hat oder für die angegebenen Anforderungen registriert wurde, die Anwendung sich jedoch nicht in der Liste der gespeicherten Priorität befindet. Das heißt, es befindet sich nur in der temporären Prioritätsliste. In API-Version 2.0 oder höher wird der Wert 0 zurückgegeben, um diese Bedingung anzugeben.

Andernfalls gibt der Wert die Anwendungsposition in der Liste an. 1, die höchste Priorität hat, und steigende Werte, die auf eine abnehmende Priorität hinweisen.

Rückgabewert

Gibt null zurück, wenn die Anforderung erfolgreich ist, oder eine negative Fehlernummer, wenn ein Fehler auftritt. Mögliche Rückgabewerte sind:

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

Hinweise

Wenn LINEERR_INVALMEDIAMODE zurückgegeben wird, ist der in dwMediaMode angegebene Wert nicht Null, kein gültiger erweiterter Medienmodus und keine der LINEMEDIAMODE_ Konstanten oder mehr als ein Bit ist im Parameterwert aktiviert.