IVsUserData Interface

Allows a caller to use a GUID to set or get user data (properties).

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

Syntax

'Declaration
<GuidAttribute("978A8E17-4DF8-432A-9623-D530A26452BC")> _
<InterfaceTypeAttribute()> _
Public Interface IVsUserData
[GuidAttribute("978A8E17-4DF8-432A-9623-D530A26452BC")]
[InterfaceTypeAttribute()]
public interface IVsUserData
[GuidAttribute(L"978A8E17-4DF8-432A-9623-D530A26452BC")]
[InterfaceTypeAttribute()]
public interface class IVsUserData
[<GuidAttribute("978A8E17-4DF8-432A-9623-D530A26452BC")>]
[<InterfaceTypeAttribute()>]
type IVsUserData =  interface end
public interface IVsUserData

The IVsUserData type exposes the following members.

Methods

  Name Description
Public method GetData Returns user data from a buffer.
Public method SetData Sets user data to a buffer.

Top

Remarks

The IVsUserData interface is a generic grouping of properties, the most important of which is the buffer's moniker. This interface is used to set or retrieve properties (data) from the buffer. A GUID indexes the properties, which are then returned in a VARIANT.

Using IVsUserData is not a particularly efficient way to get and set user data. For quick access (idle time, loops, time-critical code, and so on), it is recommended that you cache the data instead.

Notes to Implementers

Implement in cases where text buffer objects need to get or set user data.

See Also

Reference

Microsoft.VisualStudio.TextManager.Interop Namespace