Colorizer.GetStateMaintenanceFlag(Int32) Method

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

Called to determine if the colorizer requires per line state management.

public:
 virtual int GetStateMaintenanceFlag([Runtime::InteropServices::Out] int % flag);

 virtual int GetStateMaintenanceFlag([Runtime::InteropServices::Out] int & flag);

public virtual int GetStateMaintenanceFlag (out int flag);

abstract member GetStateMaintenanceFlag : int -> int
override this.GetStateMaintenanceFlag : int -> int

Public Overridable Function GetStateMaintenanceFlag (ByRef flag As Integer) As Integer

Parameters

flag

Int32

[out] Returns nonzero if the colorizer requires parsing state to be tracked per line; otherwise, returns zero.

Returns

Int32

If successful, returns S_OK; otherwise, returns an error code.

Implements

GetStateMaintenanceFlag(Int32)

Remarks

This method is used to determine if the colorizer requires managing the parsing state for each line of source. If the colorizer does require managing line by line state, the editing performance may suffer. Note that the managed package framework version of Colorizer assumes a line-by-line state.

This method is an implementation of GetStateMaintenanceFlag.

The base method returns a 1 if the suspended state is 0; otherwise, it returns a 0.

The colorizer can be suspended by a call to Suspend and resumed by a call to Resume. This method indicates the current suspension state. The colorizer is suspended while handling code snippet expansion (colorization is unnecessary until the expansion is completed). Note that the base class does not pay attention to this flag although it is maintained.