Funzione StartDocA (wingdi.h)

Articolo
03/08/2023

La funzione StartDoc avvia un processo di stampa.

Sintassi

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

Parametri

[in] hdc

Handle per il contesto del dispositivo per il processo di stampa.

[in] lpdi

Puntatore a una struttura DOCINFO contenente il nome del file di documento e il nome del file di output.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è maggiore di zero. Questo valore è l'identificatore del processo di stampa per il documento.

Se la funzione ha esito negativo, il valore restituito è minore o uguale a zero.

Commenti

Nota Si tratta di una funzione di blocco o sincrona e potrebbe non restituire immediatamente. La velocità di restituzione di questa funzione dipende da fattori di runtime, ad esempio lo stato della rete, la configurazione del server di stampa e l'implementazione del driver della stampante, fattori difficili da prevedere durante la scrittura di un'applicazione. Chiamando questa funzione da un thread che gestisce l'interazione con l'interfaccia utente, l'applicazione potrebbe sembrare non rispondente.

Le applicazioni devono chiamare la funzione StartDoc immediatamente prima di iniziare un processo di stampa. L'uso di questa funzione garantisce che i documenti a più pagine non siano interpersi con altri processi di stampa.

Le applicazioni possono usare il valore restituito da StartDoc per recuperare o impostare la priorità di un processo di stampa. Chiamare la funzione GetJob o SetJob e specificare questo valore come uno degli argomenti necessari.

Esempio

Per un programma di esempio che usa questa funzione, vedere Procedura: Stampare usando l'API di stampa GDI.

Nota

L'intestazione wingdi.h definisce StartDoc come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti


Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	wingdi.h (include Windows.h)
Libreria	Gdi32.lib
DLL	Gdi32.dll