Функция SetForm

  • Статья

Функция SetForm задает сведения о форме для указанного принтера.

Синтаксис

BOOL SetForm(
  _In_ HANDLE hPrinter,
  _In_ LPTSTR pFormName,
  _In_ DWORD  Level,
  _In_ LPTSTR pForm
);

Параметры

hPrinter [in]

Дескриптор принтера, для которого заданы сведения о форме. Используйте функцию OpenPrinter или AddPrinter для получения дескриптора принтера.

pFormName [in]

Указатель на строку, завершающуюся нулевым значением, которая указывает имя формы, для которой заданы сведения о форме.

Level [in]

Версия структуры, на которую указывает pForm . Это значение должно быть равно 1 или 2.

pForm [in]

Указатель на структуру FORM_INFO_1 или FORM_INFO_2 .

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

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

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

Комментарии

Примечание

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

SetForm можно вызывать несколько раз для существующего FORM_INFO_2, каждый вызов добавляет дополнительные пары значений pDisplayName и wLangId . Все языковые версии формы будут получать значения Size и ImageableAreaFORM_INFO_2 в последнем вызове SetForm.

Если вызывающий объект является удаленным, а уровень равен 2, значение StringTypeFORM_INFO_2 нельзя STRING_MUIDLL.

Требования

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

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

Вывод на печать

Функции API очереди печати принтера

GetForm

OpenPrinter

FORM_INFO_1

FORM_INFO_2