Функция FaxEnumRoutingMethodsA (winfax.h)

Статья
2024-11-20

Функция FaxEnumRoutingMethods перечисляет все методы маршрутизации факсов для определенного факс-устройства. Функция возвращает сведения о каждом методе маршрутизации в клиентское приложение факса.

Синтаксис

WINFAXAPI BOOL FaxEnumRoutingMethodsA(
  [in]  HANDLE               FaxPortHandle,
  [out] PFAX_ROUTING_METHODA *RoutingMethod,
  [out] LPDWORD              MethodsReturned
);

Параметры

[in] FaxPortHandle

Тип: HANDLE

Задает дескриптор факса, возвращаемый вызовом функции FaxOpenPort.

[out] RoutingMethod

Тип: PFAX_ROUTING_METHOD*

Указатель на адрес буфера для получения массива FAX_ROUTING_METHOD структур. Каждая структура содержит сведения о одном методе маршрутизации факсов. Данные включают в себя, среди прочего, имя библиотеки DLL, экспортируемой методом маршрутизации, guid и имя функции, определяющие метод маршрутизации, а также понятное имя метода.

Сведения о выделении памяти см. в следующем разделе "Примечания". Сведения о методах маршрутизации факсов см. в api расширения маршрутизации факсов.

[out] MethodsReturned

Тип: LPDWORD

Указатель на переменную DWORD , чтобы получить количество структур FAX_ROUTING_METHOD, функция FaxEnumRoutingMethod s возвращается в параметре RoutingMethod.

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

Тип: BOOL

Если функция выполнена успешно, возвращаемое значение ненулевое.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError. GetLastError может возвращать одну из следующих ошибок.

Возвращаемый код	Описание
ERROR_ACCESS_DENIED	Доступ запрещен. требуется FAX_PORT_QUERY доступ.
ERROR_INVALID_PARAMETER	Один или все параметры MethodsReturned, RoutingMethodили FaxPortHandleNULL.
ERROR_NOT_ENOUGH_MEMORY	Произошла ошибка во время выделения памяти.

Замечания

Приложение администрирования факсов обычно вызывает функцию FaxEnumRoutingMethods для запроса методов маршрутизации факсов, связанных с определенным устройством. Вызов функции FaxSetRoutingInfo изменяет сведения о маршрутизации для определенного метода маршрутизации факсов.

Функция FaxEnumGlobalRoutingInfo извлекает сведения о маршрутизации, которые применяются глобально к факс-серверу, например приоритет маршрутизации. Приложение может изменять глобальные данные с помощью вызова функции FaxSetGlobalRoutingInfo.

Функция FaxEnumRoutingMethods выделяет память, необходимую для массива буферов FAX_ROUTING_METHOD, на который указывает параметр RoutingMethod. Приложение должно вызвать функцию FaxFreeBuffer, чтобы освободить ресурсы, связанные с этим параметром.

Дополнительные сведения см. в управления конфигурацией факсов и освобождение ресурсов факсов.

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winfax.h
библиотеки	WinFax.lib