Функция AddForm

Статья
06/12/2023

Функция AddForm добавляет форму в список доступных форм, которые можно выбрать для указанного принтера.

Синтаксис

BOOL AddForm(
  _In_ HANDLE hPrinter,
  _In_ DWORD  Level,
  _In_ LPBYTE pForm
);

Параметры

hPrinter [in]: Дескриптор принтера, поддерживающий печать в указанной форме. Используйте функцию OpenPrinter или AddPrinter , чтобы получить дескриптор принтера.
Level [in]: Уровень структуры, на которую указывает pForm . Это значение должно быть равно 1 или 2.
pForm [in]: Указатель на структуру FORM_INFO_1 или FORM_INFO_2 .

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

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

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

Это блокирующая или синхронная функция, возвращаемая не сразу. Скорость возврата этой функции зависит от факторов времени выполнения, таких как состояние сети, конфигурация сервера печати и факторы реализации драйвера принтера, которые трудно предсказать при написании приложения. Вызов этой функции из потока, который управляет взаимодействием с пользовательским интерфейсом, может привести к тому, что приложение не отвечает.

Приложение может определить, какие формы доступны для принтера, вызвав функцию EnumForms .

Если pForm указывает на FORM_INFO_2, addForm завершится ошибкой, если форма с указанным именем уже существует или значение pKeyword структуры уже существует.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Заголовок	Winspool.h (включая Windows.h)
Библиотека	Winspool.lib
DLL	Spoolss.dll

См. также раздел

Вывод на печать
Функции API очереди печати принтера
EnumForms
FORM_INFO_1
FORM_INFO_2
OpenPrinter