IVsUserData.GetData Method

Returns user data from a buffer.

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

Syntax

'Declaration
Function GetData ( _
    ByRef riidKey As Guid, _
    <OutAttribute> ByRef pvtData As Object _
) As Integer

int GetData(
    ref Guid riidKey,
    out Object pvtData
)

int GetData(
    [InAttribute] Guid% riidKey, 
    [OutAttribute] Object^% pvtData
)

abstract GetData : 
        riidKey:Guid byref * 
        pvtData:Object byref -> int 

function GetData(
    riidKey : Guid, 
    pvtData : Object
) : int

Parameters

• riidKey
  Type: System.Guid%
  [in] Unique identifier of the data.

• pvtData
  Type: System.Object%
  [out] Pointer to a VARIANT containing the user data.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsUserData::GetData(
   [in] REFGUID riidKey,
   [out] VARIANT *pvtData
);

If you want to retain the contents of the variant, then copy the data to the cache.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsUserData Interface

Microsoft.VisualStudio.TextManager.Interop Namespace