Condividi tramite

Funzione EngGetForm (winddi.h)

  • Articolo

La funzione EngGetForm ottiene i dettagli FORM_INFO_1 per il modulo specificato.

Sintassi

ENGAPI BOOL EngGetForm(
  [in]           HANDLE  hPrinter,
  [in]           LPWSTR  pFormName,
  [in]           DWORD   Level,
  [in, optional] LPBYTE  pForm,
  [in]           DWORD   cbBuf,
  [out]          LPDWORD pcbNeeded
);

Parametri

[in] hPrinter

Handle per la stampante per cui viene specificato il modulo.

[in] pFormName

Puntatore a una stringa che specifica il nome del form.

[in] Level

Specifica la versione della struttura del modulo a cui punta pForm . Questo valore deve essere 1, che indica che le informazioni sul modulo verranno restituite in una struttura FORM_INFO_1.

[in, optional] pForm

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

[in] cbBuf

Specifica le dimensioni, in byte, di pForm.

[out] pcbNeeded

Puntatore a un valore che specifica il numero di byte copiati nel buffer a cui punta pForm se la funzione ha esito positivo. Il valore è il numero di byte necessari per eseguire la copia se cbBuf è troppo piccolo.

Valore restituito

EngGetForm restituisce TRUE se la struttura del modulo viene copiata correttamente in pForm. In caso contrario, registra un messaggio di errore e restituisce FALSE. Per ottenere le informazioni sull'errore, chiamare EngGetLastError.

Commenti

EngGetForm restituisce una struttura FORM_INFO_1 (descritta nella documentazione Microsoft Windows SDK) contenente i dati del modulo associati a pFormName. I dati scritti e le relative dimensioni vengono restituiti al chiamante rispettivamente tramite pForm e pcbNeeded. Se la matrice a cui punta pForm non è sufficientemente grande da contenere i dati del modulo, la dimensione della matrice richiesta viene invece restituita in pcbNeeded.

Per ottenere un elenco di tutti i moduli supportati, il driver della stampante deve chiamare EngEnumForms.

Requisiti

Requisito Valore
Client minimo supportato Disponibile in Windows 2000 e versioni successive dei sistemi operativi Windows.
Piattaforma di destinazione Universale
Intestazione winddi.h (include Winddi.h)
Libreria Win32k.lib
DLL Win32k.sys

Vedi anche

EngEnumForms

EngGetLastError