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
'Usage
Dim instance As IVsUserData
[GuidAttribute("978A8E17-4DF8-432A-9623-D530A26452BC")]
[InterfaceTypeAttribute()]
public interface IVsUserData
[GuidAttribute(L"978A8E17-4DF8-432A-9623-D530A26452BC")]
[InterfaceTypeAttribute()]
public interface class IVsUserData
public interface IVsUserData

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.

Note

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.

See illustrations of the implementation and/or calling of this interface in the sample Figures Language Service.

Notes to Implementers:

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

See Also

Reference

IVsUserData Members

Microsoft.VisualStudio.TextManager.Interop Namespace