GetConsoleTitle
The GetConsoleTitle
function retrieves the title bar string for the current console window.
DWORD GetConsoleTitle(
LPTSTR lpConsoleTitle, |
// address of
buffer for title |
DWORD nSize |
// size of the
buffer |
); |
|
Parameters
lpConsoleTitle
Points to a
buffer that receives a null-terminated string containing the text that appears
in the title bar of the console window.
nSize
Specifies the
size, in characters, of the buffer pointed to by the lpConsoleTitle
parameter.
Return Values
If the
function succeeds, the return value is the length, in characters, of the string
copied to the buffer.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError
Remarks
To set the
title bar string for a console window, use the SetConsoleTitle function.
Windows
NT: This function uses either Unicode
characters or 8-bit characters from the console's current codepage. The
console's codepage defaults initially to the system's OEM codepage. To change
the console's codepage, use the SetConsoleCP or SetConsoleOutputCP
functions, or use the chcp or mode con cp select= commands.
See Also