ConsoleAttributes.GetConsoleScreenBufferInfo Method

Mentalis.org Proxy

Mentalis.org Proxy Documentation

ConsoleAttributes.GetConsoleScreenBufferInfo Method 

The GetConsoleScreenBufferInfo function retrieves information about the specified console screen buffer.

[Visual Basic]Friend Shared Function GetConsoleScreenBufferInfo( _
   ByVal hConsoleOutput As Integer, _
   ByRef lpConsoleScreenBufferInfo As Org.Mentalis.Utilities.ConsoleAttributes.CONSOLE_SCREEN_BUFFER_INFO _
) As Integer
[C#]
internal static int GetConsoleScreenBufferInfo(
   int hConsoleOutput,
   ref CONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

Parameters

hConsoleOutput
Handle to a console screen buffer. The handle must have GENERIC_READ access.
lpConsoleScreenBufferInfo
Pointer to a CONSOLE_SCREEN_BUFFER_INFO structure in which the screen buffer information is returned.

Return Value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

See Also

ConsoleAttributes Class | ConsoleAttributes Members | Org.Mentalis.Utilities.ConsoleAttributes Namespace