ModelingDocData.GetRelatedSaveTreeItems Method

Article
04/26/2013

Standard implementation of IVsHasRelatedSaveItems. If another DocData was registered using the IRelatedDocList interface with this instance, it will potentially be returned as a RelatedSaveTreeItem.

Namespace: Microsoft.VisualStudio.Modeling.Shell
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntax

'Declaration
Public Function GetRelatedSaveTreeItems ( _
    saveItem As VSSAVETREEITEM, _
    celt As UInteger, _
    rgSaveTreeItems As VSSAVETREEITEM(), _
    <OutAttribute> ByRef pcActual As UInteger _
) As Integer

public int GetRelatedSaveTreeItems(
    VSSAVETREEITEM saveItem,
    uint celt,
    VSSAVETREEITEM[] rgSaveTreeItems,
    out uint pcActual
)

public:
virtual int GetRelatedSaveTreeItems(
    VSSAVETREEITEM saveItem, 
    unsigned int celt, 
    array<VSSAVETREEITEM>^ rgSaveTreeItems, 
    [OutAttribute] unsigned int% pcActual
) sealed

abstract GetRelatedSaveTreeItems : 
        saveItem:VSSAVETREEITEM * 
        celt:uint32 * 
        rgSaveTreeItems:VSSAVETREEITEM[] * 
        pcActual:uint32 byref -> int  
override GetRelatedSaveTreeItems : 
        saveItem:VSSAVETREEITEM * 
        celt:uint32 * 
        rgSaveTreeItems:VSSAVETREEITEM[] * 
        pcActual:uint32 byref -> int

public final function GetRelatedSaveTreeItems(
    saveItem : VSSAVETREEITEM, 
    celt : uint, 
    rgSaveTreeItems : VSSAVETREEITEM[], 
    pcActual : uint
) : int

Parameters

saveItem
Type: Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM

Pointer to a VSSAVETREEITEM structure containing information about the item to check ("this") for related items

celt
Type: UInt32

The number of documents to save

rgSaveTreeItems
Type: array<Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM[]

Pointer to an array of VSSAVETREEITEM structures containing information about related items to save

pcActual
Type: UInt32%

Pointer to an integer that is the number of related items to save or the number of elements in rgSaveTreeItems

Return Value

Type: Int32
ErrorCode to indicate success or failure

Implements

Remarks

Expect Shell to call this twice. First time, with a null rgSaveTreeItems and we need to return the number of items to save in pcActual. Second time, shell will pass an initialized array of old pcActual size that we need to populate with the items we need to call save on.

.NET Framework Security

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.