Функция StartDocA (wingdi.h)

Статья
08/27/2023

Функция StartDoc запускает задание печати.

Синтаксис

int StartDocA(
  [in] HDC            hdc,
  [in] const DOCINFOA *lpdi
);

Параметры

[in] hdc

Дескриптор контекста устройства для задания печати.

[in] lpdi

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

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

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

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

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

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

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

Примеры

Пример программы, использующий эту функцию, см. в разделе Практическое руководство. Печать с помощью API печати GDI.

Примечание

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

Требования


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	wingdi.h (включая Windows.h)
Библиотека	Gdi32.lib
DLL	Gdi32.dll