Share via

IVsHiddenRegion.SetClientData Method

  • Reference

Definition

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

Overloads

SetClientData(IntPtr)
SetClientData(UInt32)

Sets the client data for the hidden region.

SetClientData(IntPtr) 

public:
 int SetClientData(IntPtr dwData);
public int SetClientData (IntPtr dwData);
abstract member SetClientData : nativeint -> int
Public Function SetClientData (dwData As IntPtr) As Integer

Parameters

dwData
IntPtr

nativeint

Returns

Int32

Applies to

SetClientData(UInt32)

Sets the client data for the hidden region.

public:
 int SetClientData(System::UInt32 dwData);
public:
 int SetClientData(unsigned int dwData);
int SetClientData(unsigned int dwData);
public int SetClientData (uint dwData);
abstract member SetClientData : uint32 -> int
Public Function SetClientData (dwData As UInteger) As Integer

Parameters

dwData
UInt32

[in] 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::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.

Applies to