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

Статья
11/20/2024

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

Синтаксис

int StartDocW(
  [in] HDC            hdc,
  [in] const DOCINFOW *lpdi
);

Параметры

[in] hdc

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

[in] lpdi

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

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

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

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

Замечания

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

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

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

Примеры

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

Заметка

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

Требования

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