Функция lineGetAppPriorityW (tapi.h)

Функция lineGetAppPriority позволяет приложению определить, находится ли он в списке приоритетов передачи для определенного режима мультимедиа или режима запроса вспомогательной телефонии и, если да, его положение в списке приоритетов.

Синтаксис

LONG lineGetAppPriorityW(
  LPCWSTR           lpszAppFilename,
  DWORD             dwMediaMode,
  LPLINEEXTENSIONID lpExtensionID,
  DWORD             dwRequestMode,
  LPVARSTRING       lpExtensionName,
  LPDWORD           lpdwPriority
);

Параметры

lpszAppFilename

Указатель на строку, содержащую имя файла исполняемого модуля приложения без данных каталога. В API версии 2.0 или более поздней параметр может находиться в формате длинного имени файла, из которого формат имени файла 8.3 является правильным подмножеством. Длинные имена файлов, в отличие от имен файлов 8.3, сохраняются. Ни формат имени файла не учитывает регистр. Дополнительные сведения см. в соглашения о имени файлов. В версиях API до версии 2.0 параметр должен указать имя файла в формате 8.3; Имена длинных файлов нельзя использовать.

dwMediaMode

Режим мультимедиа, для которого необходимо получить данные приоритета. Значение может быть одним из LINEMEDIAMODE_ констант; только один бит может быть включен. Значение 0 следует использовать при проверке приоритета приложения для запросов вспомогательной телефонии.

lpExtensionID

Указатель на структуру типа LINEEXTENSIONID. Этот параметр игнорируется.

dwRequestMode

Условия этого параметра, если параметр dwMediaMode равен нулю, этот параметр задает режим запроса вспомогательной телефонии, для которого необходимо проверить приоритет. Он должен быть LINEREQUESTMODE_MAKECALL. Этот параметр игнорируется, если dwMediaMode не равно нулю.

lpExtensionName

Этот параметр игнорируется.

lpdwPriority

Указатель на расположение памяти DWORDразмера, в которое TAPI записывает приоритет приложения для указанного режима мультимедиа или запроса. Значение 0 возвращается, если приложение не находится в сохраненном списке приоритетов и в настоящее время не имеет устройства строки, открытого с правами владения, запрошенного для указанного режима мультимедиа или зарегистрированного для указанного режима запроса.

В версиях API, предшествующих 2.0, возвращается значение –1 (0xFFFFFFFF), если у приложения открыта строка для указанного режима мультимедиа или зарегистрирована для указанных запросов, но приложение не находится в сохраненном списке приоритетов; то есть он находится только в списке временных приоритетов. В API версии 2.0 или более поздней возвращается значение 0, указывающее это условие.

В противном случае значение указывает положение приложения в списке; 1 является самым высоким приоритетом и увеличивает значения, указывающие на снижение приоритета.

Возвращаемое значение

Возвращает ноль, если запрос выполнен успешно или отрицательный номер ошибки, если возникает ошибка. Возможные возвращаемые значения:

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

Замечания

Если возвращается LINEERR_INVALMEDIAMODE, то значение, указанное в dwMediaMode, не равно нулю, а не допустимому расширенному режиму мультимедиа, а не одному из констант LINEMEDIAMODE_, или несколько битов включены в значение параметра.

Заметка

Заголовок tapi.h определяет lineGetAppPriority как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
целевая платформа	Виндоус
заголовка	tapi.h
библиотеки	Tapi32.lib
DLL	Tapi32.dll

См. также

LINEEXTENSIONID

дополнительных функций службы

Обзор TAPI 2.2

VARSTRING