IVsSimpleObjectList2.GetDisplayData Method

Article
04/22/2008

Retrieves data to draw the requested tree list item.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Déclaration
Function GetDisplayData ( _
    index As UInteger, _
    <OutAttribute> pData As VSTREEDISPLAYDATA() _
) As Integer
'Utilisation
Dim instance As IVsSimpleObjectList2
Dim index As UInteger
Dim pData As VSTREEDISPLAYDATA()
Dim returnValue As Integer

returnValue = instance.GetDisplayData(index, _
    pData)

int GetDisplayData(
    uint index,
    VSTREEDISPLAYDATA[] pData
)

int GetDisplayData(
    [InAttribute] unsigned int index, 
    [OutAttribute] array<VSTREEDISPLAYDATA>^ pData
)

function GetDisplayData(
    index : uint, 
    pData : VSTREEDISPLAYDATA[]
) : int

Parameters

index
Type: System.UInt32

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

pData
Type: array<Microsoft.VisualStudio.Shell.Interop.VSTREEDISPLAYDATA[]

[out] Pointer to a VSTREEDISPLAYDATA structure containing the display 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 vsshell80.idl:

HRESULT IVsSimpleObjectList2::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.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via