IVsHiddenRegion.GetClientData Method

Artigo
08/02/2012

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

'Declaração
Function GetClientData ( _
    <OutAttribute> ByRef pdwData As UInteger _
) As Integer

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

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.

Partilhar via