Funzione GetForm

La funzione GetForm recupera informazioni su un modulo specificato.

Sintassi

BOOL GetForm(
  _In_  HANDLE  hPrinter,
  _In_  LPTSTR  pFormName,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pForm,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded
);

Parametri

hPrinter [in]

Handle per la stampante. Usare la funzione OpenPrinter o AddPrinter per recuperare un handle della stampante.

pFormName [in]

Puntatore a una stringa con terminazione null che specifica il nome del modulo. Per ottenere i nomi dei moduli supportati dalla stampante, chiamare la funzione EnumForms .

Livello [in]

Versione della struttura a cui pForm punta. Questo valore deve essere 1 o 2.

pForm [out]

Puntatore a una matrice di byte che riceve la struttura di FORM_INFO_1 inizializzata o FORM_INFO_2 .

cbBuf [in]

Dimensioni, in byte, della matrice pForm .

pcbNeeded [out]

Puntatore a un valore che specifica il numero di byte copiati se la funzione riesce o il numero di byte necessari se cbBuf è troppo piccolo.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è un valore diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero.

Commenti

Nota

Si tratta di una funzione di blocco o sincrona e potrebbe non restituire immediatamente. La velocità con cui questa funzione restituisce dipende da fattori di runtime come lo stato della rete, la configurazione del server di stampa e i fattori di implementazione del driver della stampante difficili da prevedere durante la scrittura di un'applicazione. La chiamata a questa funzione da un thread che gestisce l'interazione con l'interfaccia utente potrebbe rendere l'applicazione non rispondente.

Se il chiamante è remoto e il livello è 2, il valore StringType del FORM_INFO_2 restituito sarà sempre STRING_LANGPAIR.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Intestazione	Winspool.h (include Windows.h)
Libreria	Winspool.lib
DLL	Winspool.drv
Nomi Unicode e ANSI	GetFormW (Unicode) e GetFormA (ANSI)

Vedi anche

Stampa

Funzioni dell'API spooler di stampa

AddForm

DeleteForm

OpenPrinter

SetForm