GetConsoleScreenBufferInfo

Recupera información sobre el buffer de pantalla de la consola especificada.

Sintaxis

BOOL WINAPI GetConsoleScreenBufferInfo(
    _In_  HANDLE                      hConsoleOutput,
    _Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

Parámetros:

hConsoleOutput

Un manipulador del buffer de pantalla de la consola. El manipulador debe tener el derecho de acceso GENERIC_READ.

lpConsoleScreenBufferInfo

Un puntero a una estructura CONSOLE_SCREEN_BUFFER_INFO que recibirá la información sobre el buffer de pantalla de la consola.

Valor de retorno

Si la función tiene éxito, el valor de retorno es distinto de cero.

Si la funcuón falla, el valor de retorno es cero. Para obtener información adicional, invocar la función GetLastError.

Observaciones

El rectángulo retornado en el miembro srWindow del la estructura CONSOLE_SCREEN_BUFFER_INFO puede ser modificado y después pasado a la función SetConsoleWindowInfo para desplazar el buffer de pantalla de la consola en la ventana, para cambiar el tamaño de la ventana o ambos.

Todas las coordenadas en la estructura CONSOLE_SCREEN_BUFFER_INFO están expresadas en coordenadas de celdas de caracteresare, donde el origen (0, 0) es la esquina superior izquierda del buffer de pantalla de la consola.

Esta API no tiene equivalenet en un terminal virtual. Es posible que su uso sea necesario para aplicaciones que intenten dibujar columnas, cuadrículas o llenar la pantalla para recuperar el tamaño de la ventana. Este estado de ventana es administrado por TTY/PTY/Pseudoconsole fuera del flujo normal y generalmente considerador un privilegio para el usuario no asjutable por la aplicación cliente. Las actualizaciones se pueden recibir en ReadConsoleInput.