IVsHiddenRegion::GetClientData Method (UInt32)

Visual Studio 2015

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

C++

int GetClientData(
	[OutAttribute] unsigned int% pdwData
)

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:

C++

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.