IVsStatusbar.SetLineColChar(Object, Object, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int SetLineColChar(System::Object ^ % pvLine, System::Object ^ % pvCol, System::Object ^ % pvChar);

int SetLineColChar(winrt::Windows::Foundation::IInspectable const & & pvLine, winrt::Windows::Foundation::IInspectable const & & pvCol, winrt::Windows::Foundation::IInspectable const & & pvChar);

public int SetLineColChar (ref object pvLine, ref object pvCol, ref object pvChar);

abstract member SetLineColChar : obj * obj * obj -> int

Public Function SetLineColChar (ByRef pvLine As Object, ByRef pvCol As Object, ByRef pvChar As Object) As Integer

Parameters

pvLine: Object

[in] Line number of the cursor.

pvCol: Object

[in] Column number of the cursor.

pvChar: Object

[in] Character position of the cursor.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

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.

Applies to