Share via

IVsHiddenRegion.GetClientData Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.TextManager.Interop
Assembly:
Microsoft.VisualStudio.Interop.dll
Assembly:
Microsoft.VisualStudio.TextManager.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Overloads

GetClientData(IntPtr)
GetClientData(UInt32)

Returns the client data for the hidden region.

GetClientData(IntPtr) 

public:
 int GetClientData([Runtime::InteropServices::Out] IntPtr % pdwData);
public int GetClientData (out IntPtr pdwData);
abstract member GetClientData : nativeint -> int
Public Function GetClientData (ByRef pdwData As IntPtr) As Integer

Parameters

pdwData
IntPtr

nativeint

Returns

Int32

Applies to

GetClientData(UInt32)

Returns the client data for the hidden region.

public:
 int GetClientData([Runtime::InteropServices::Out] System::UInt32 % pdwData);
int GetClientData([Runtime::InteropServices::Out] unsigned int & pdwData);
public int GetClientData (out uint pdwData);
abstract member GetClientData : uint32 -> int
Public Function GetClientData (ByRef pdwData As UInteger) As Integer

Parameters

pdwData
UInt32

[out] Pointer to a double word containing the data.

Returns

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.

Applies to