IVsTextStorage2.GetVersionCookie(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Gets a version cookie on the data.

public:
 int GetVersionCookie([Runtime::InteropServices::Out] System::UInt32 % pdwVersionCookie);

int GetVersionCookie([Runtime::InteropServices::Out] unsigned int & pdwVersionCookie);

public int GetVersionCookie (out uint pdwVersionCookie);

abstract member GetVersionCookie : uint32 -> int

Public Function GetVersionCookie (ByRef pdwVersionCookie As UInteger) As Integer

Parameters

pdwVersionCookie: UInt32

[out] The version cookie.

Returns

Int32

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

Remarks

The version cookie starts at 0 and is incremented every time the data in the text storage is changed.

This method should provide a quick test to determine whether the text storage contents have changed. It may produce false positives (e.g. incrementing the version number even though no substantive change was made (for example, replacing "a" with "a").

Applies to