Compartir a través de

Función EngGetForm (winddi.h)

  • Artículo

La función EngGetForm obtiene los detalles FORM_INFO_1 del formulario especificado.

Sintaxis

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

Parámetros

[in] hPrinter

Identificador de la impresora para la que se especifica el formulario.

[in] pFormName

Puntero a una cadena que especifica el nombre del formulario.

[in] Level

Especifica la versión de la estructura de formulario a la que apunta pForm . Este valor debe ser 1, lo que indica que la información del formulario se devolverá en una estructura FORM_INFO_1.

[in, optional] pForm

Puntero a una matriz de bytes que recibe la estructura de FORM_INFO_1 inicializada.

[in] cbBuf

Especifica el tamaño, en bytes, de pForm.

[out] pcbNeeded

Puntero a un valor que especifica el número de bytes copiados en el búfer al que apunta pForm si la función se realiza correctamente. El valor es el número de bytes necesarios para realizar la copia si cbBuf es demasiado pequeño.

Valor devuelto

EngGetForm devuelve TRUE si la estructura del formulario se copia correctamente en pForm. De lo contrario, registra un mensaje de error y devuelve FALSE. Para obtener la información de error, llame a EngGetLastError.

Comentarios

EngGetForm devuelve una estructura FORM_INFO_1 (descrita en la documentación de Microsoft Windows SDK) que contiene los datos del formulario asociados a pFormName. Los datos escritos y su tamaño se devuelven al autor de la llamada a través de pForm y pcbNeeded, respectivamente. Si la matriz a la que apunta pForm no es lo suficientemente grande como para contener los datos del formulario, en su lugar se devuelve el tamaño de matriz necesario en pcbNeeded.

Para obtener una lista de todos los formularios admitidos, el controlador de impresora debe llamar a EngEnumForms.

Requisitos

Requisito Value
Cliente mínimo compatible Disponible en Windows 2000 y versiones posteriores de los sistemas operativos Windows.
Plataforma de destino Universal
Encabezado winddi.h (incluya Winddi.h)
Library Win32k.lib
Archivo DLL Win32k.sys

Consulte también

EngEnumForms

EngGetLastError