Leer en inglés

Compartir a través de


Función GetForm

La función GetForm recupera información sobre un formulario especificado.

Sintaxis

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

Parámetros

hPrinter [in]

Identificador de la impresora. Use la función OpenPrinter o AddPrinter para recuperar un identificador de impresora.

pFormName [in]

Puntero a una cadena terminada en null que especifica el nombre del formulario. Para obtener los nombres de los formularios admitidos por la impresora, llame a la función EnumForms .

Nivel [in]

Versión de la estructura a la que apunta pForm . Este valor debe ser 1 o 2.

pForm [out]

Puntero a una matriz de bytes que recibe el FORM_INFO_1 inicializado o FORM_INFO_2 estructura.

cbBuf [in]

Tamaño, en bytes, de la matriz pForm .

pcbNeededed [out]

Puntero a un valor que especifica el número de bytes copiados si la función se realiza correctamente o el número de bytes necesarios si cbBuf es demasiado pequeño.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero.

Comentarios

Nota

Se trata de una función de bloqueo o sincrónica y podría no devolverse inmediatamente. La rapidez con la que devuelve esta función depende de factores en tiempo de ejecución, como el estado de red, la configuración del servidor de impresión y los factores de implementación de controladores de impresora que son difíciles de predecir al escribir una aplicación. Llamar a esta función desde un subproceso que administra la interacción con la interfaz de usuario podría hacer que la aplicación parezca que no responde.

Si el autor de la llamada es remoto y el nivel es 2, el valor StringType del FORM_INFO_2 devuelto siempre será STRING_LANGPAIR.

Requisitos

Requisito Value
Cliente mínimo compatible
Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible
Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado
Winspool.h (incluye Windows.h)
Biblioteca
Winspool.lib
Archivo DLL
Winspool.drv
Nombres Unicode y ANSI
GetFormW (Unicode) y GetFormA (ANSI)

Consulte también

Impresión

Funciones de la API del administrador de trabajos de impresión

AddForm

DeleteForm

OpenPrinter

SetForm