IVsHiddenRegion::SetClientData Method (UInt32)

Visual Studio 2015

Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Visual Studio 2005

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

C++

int SetClientData(
	unsigned int dwData
)

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:

C++

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.