DocData.GetData Method

Gets the document data from a buffer.

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
Public Function GetData ( _
    ByRef riidKey As Guid, _
    <OutAttribute> ByRef pvtData As Object _
) As Integer
public int GetData(
    ref Guid riidKey,
    out Object pvtData
)
public:
virtual int GetData(
    Guid% riidKey, 
    [OutAttribute] Object^% pvtData
) sealed
abstract GetData : 
        riidKey:Guid byref * 
        pvtData:Object byref -> int  
override GetData : 
        riidKey:Guid byref * 
        pvtData:Object byref -> int
public final function GetData(
    riidKey : Guid, 
    pvtData : Object
) : int

Parameters

  • riidKey
    Type: System.Guid%

    The ID that is assigned to the document data.

  • pvtData
    Type: System.Object%

    The VARIANT that contains the document data.

Return Value

Type: System.Int32
S_OK if the document is retrieved from a buffer; otherwise, E_FAIL.

Implements

IVsUserData.GetData(Guid%, Object%)

Remarks

This method implements the IVsUserData interface.

.NET Framework Security

See Also

Reference

DocData Class

Microsoft.VisualStudio.Modeling.Shell Namespace