IVsHiddenRegion.SetClientData Method

Article
05/06/2010

Sets 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 SetClientData ( _
    dwData As UInteger _
) As Integer
'Utilisation
Dim instance As IVsHiddenRegion
Dim dwData As UInteger
Dim returnValue As Integer

returnValue = instance.SetClientData(dwData)

int SetClientData(
    uint dwData
)

int SetClientData(
    [InAttribute] unsigned int dwData
)

abstract SetClientData : 
        dwData:uint32 -> int

function SetClientData(
    dwData : uint
) : int

Parameters

dwData
Type: System.UInt32
[in] 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::SetClientData(
   [in] DWORD_PTR dwData
);

As the client, you define what information this method retrieves. This method, in conjunction with GetClientData, 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.

Partager via