IVsStatusbar::SetLineColChar Method (Object^, Object^, Object^)

Visual Studio 2015

Displays the line number, column number, and character position in the editor information area of the status bar.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int SetLineColChar(
	[InAttribute] Object^% pvLine,
	[InAttribute] Object^% pvCol,
	[InAttribute] Object^% pvChar
)

Parameters

pvLine: Type: System::Object^
[in] Line number of the cursor.

pvCol: Type: System::Object^
[in] Column number of the cursor.

pvChar: Type: System::Object^
[in] Character position of the cursor.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsStatusbar::SetLineColChar(
   [in]VARIANT *pvLine,
   [in]VARIANT *pvCol,
   [in]VARIANT *pvChar
);

The line number, column and character position are displayed as "Ln##Col##Ch##" in the editor information area of the status bar.

For all parameters, pass in null to leave their values unchanged. The VARIANT for each parameter must be VT_I2, VT_I4, VT_BSTR, or VT_EMPTY. If it is VT_I2 or VT_I4, the number is formatted into Ln ##, Col ##, Ch ##. If it is VT_BSTR, the text is displayed as is, with no formatting. If it is VT_EMPTY, that field is not displayed.

The difference between column and character positions is evident for characters such as the tab character that can incorporate more than one column.