ConsoleAttributes.SetConsoleCursorPosition Method

Mentalis.org Proxy

Mentalis.org Proxy Documentation

ConsoleAttributes.SetConsoleCursorPosition Method 

The SetConsoleCursorPosition function sets the cursor position in the specified console screen buffer.

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

Parameters

hConsoleOutput
Handle to a console screen buffer. The handle must have GENERIC_WRITE access.
dwCursorPosition
Specifies a COORD structure containing the new cursor position. The coordinates are the column and row of a screen buffer character cell. The coordinates must be within the boundaries of the screen buffer.

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