IVsObjectList2.GetDisplayData(UInt32, VSTREEDISPLAYDATA[]) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Retrieves data to draw the requested tree list item.

public:
 int GetDisplayData(System::UInt32 index, cli::array <Microsoft::VisualStudio::Shell::Interop::VSTREEDISPLAYDATA> ^ pData);

int GetDisplayData(unsigned int index, std::Array <Microsoft::VisualStudio::Shell::Interop::VSTREEDISPLAYDATA> const & pData);

public int GetDisplayData (uint index, Microsoft.VisualStudio.Shell.Interop.VSTREEDISPLAYDATA[] pData);

abstract member GetDisplayData : uint32 * Microsoft.VisualStudio.Shell.Interop.VSTREEDISPLAYDATA[] -> int

Public Function GetDisplayData (index As UInteger, pData As VSTREEDISPLAYDATA()) As Integer

Parameters

index

UInt32

[in] Specifies the index of the node of interest.

pData

VSTREEDISPLAYDATA[]

[out] Pointer to a VSTREEDISPLAYDATA structure containing the display data.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

[C++]

HRESULT IVsObjectList2::GetDisplayData(  
   [in] ULONG Index,   
   [out] VSTREEDISPLAYDATA *pData  
);  

The pData parameter is a VSTREEDISPLAYDATA structure which is used to request specific display parameters for the requested tree list item. For more detailed information see VSTREEDISPLAYDATA, _VSTREEDISPLAYMASK, and _VSTREEDISPLAYSTATE.

The tree view sets Mask and StateMask in pData to indicate which display or state data items are of interest, so only those items need to be returned. If State is set, it indicates that StateMask specifies the state data that is being requested. If TDS_STATEIMAGEMASK is not set, the tree view uses its default image list. Typically GetDisplayData is called separately for display data and state data.