IVsHiddenRegion.GetClientData Method

Returns the client data for the hidden region.

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

Syntax

'Déclaration
Function GetClientData ( _
    <OutAttribute> ByRef pdwData As UInteger _
) As Integer
'Utilisation
Dim instance As IVsHiddenRegion
Dim pdwData As UInteger
Dim returnValue As Integer

returnValue = instance.GetClientData(pdwData)
int GetClientData(
    out uint pdwData
)
int GetClientData(
    [OutAttribute] unsigned int% pdwData
)
abstract GetClientData : 
        pdwData:uint32 byref -> int 
function GetClientData(
    pdwData : uint
) : int

Parameters

  • pdwData
    Type: System.UInt32%
    [out] Pointer to a double word containing the 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 IVsHiddenRegion::GetClientData(
   [out] DWORD_PTR *pdwData
);

As the client, you define what information this method retrieves. This method, in conjunction with SetClientData, allows you to store four bytes of data on every hidden region and retrieve it as required. The editor does not use this information.

.NET Framework Security

See Also

Reference

IVsHiddenRegion Interface

IVsHiddenRegion Members

Microsoft.VisualStudio.TextManager.Interop Namespace