Platform SDK: Files and I/O |
The CreateConsoleScreenBuffer function creates a console screen buffer.
HANDLE CreateConsoleScreenBuffer( DWORD dwDesiredAccess, // access DWORD dwShareMode, // buffer share mode CONST LPSECURITY_ATTRIBUTES lpSecurityAttributes, // SD DWORD dwFlags, // buffer type LPVOID lpScreenBufferData // reserved );
Value | Meaning |
---|---|
GENERIC_READ | Requests read access to the console screen buffer, enabling the process to read data from the buffer. |
GENERIC_WRITE | Requests write access to the console screen buffer, enabling the process to write data to the buffer. |
Value | Meaning |
---|---|
FILE_SHARE_READ | Other open operations can be performed on the console screen buffer for read access. |
FILE_SHARE_WRITE | Other open operations can be performed on the console screen buffer for write access. |
Windows NT/2000: The lpSecurityDescriptor member of the structure specifies a security descriptor for the new console screen buffer. If lpSecurityAttributes is NULL, the console screen buffer gets a default security descriptor.
If the function succeeds, the return value is a handle to the new console screen buffer.
If the function fails, the return value is INVALID_HANDLE_VALUE. To get extended error information, call GetLastError.
A console can have multiple screen buffers but only one active screen buffer. Inactive screen buffers can be accessed for reading and writing, but only the active screen buffer is displayed. To make the new screen buffer the active screen buffer, use the SetConsoleActiveScreenBuffer function.
The calling process can use the returned handle in any function that requires a handle to a console screen buffer, subject to the limitations of access specified by the dwDesiredAccess parameter.
The calling process can use the DuplicateHandle function to create a duplicate screen buffer handle that has different access or inheritability from the original handle. However, DuplicateHandle cannot be used to create a duplicate that is valid for a different process (except through inheritance).
To close the screen buffer handle, use the CloseHandle function.
Windows NT/2000: Requires Windows NT 3.1 or later.
Windows 95/98: Requires Windows 95 or later.
Header: Declared in Wincon.h; include Windows.h.
Library: Use Kernel32.lib.
Consoles and Character-Mode Support Overview, Console Functions, CloseHandle, DuplicateHandle, GetConsoleScreenBufferInfo, SECURITY_ATTRIBUTES, SetConsoleActiveScreenBuffer, SetConsoleScreenBufferSize