ConsoleAttributes.GetConsoleTitle Method

Mentalis.org Proxy

Mentalis.org Proxy Documentation

ConsoleAttributes.GetConsoleTitle Method 

The GetConsoleTitle function retrieves the title bar string for the current console window.

[Visual Basic]Friend Shared Function GetConsoleTitle( _
   ByVal lpConsoleTitle As System.Text.StringBuilder, _
   ByVal nSize As Integer _
) As Integer
[C#]
internal static int GetConsoleTitle(
   StringBuilder lpConsoleTitle,
   int nSize
);

Parameters

lpConsoleTitle
Pointer 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 Value

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.

See Also

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