ModelingDocData.GetRelatedSaveTreeItems Method

Definition

Namespace:

Microsoft.VisualStudio.Modeling.Shell

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.Shell.dll

Package:

Microsoft.VisualStudio.Modeling.Sdk.Shell v17.10.40171

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

public:
 virtual int GetRelatedSaveTreeItems(Microsoft::VisualStudio::Shell::Interop::VSSAVETREEITEM saveItem, System::UInt32 celt, cli::array <Microsoft::VisualStudio::Shell::Interop::VSSAVETREEITEM> ^ rgSaveTreeItems, [Runtime::InteropServices::Out] System::UInt32 % pcActual);

public int GetRelatedSaveTreeItems (Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM saveItem, uint celt, Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM[] rgSaveTreeItems, out uint pcActual);

abstract member GetRelatedSaveTreeItems : Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM * uint32 * Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM[] * uint32 -> int
override this.GetRelatedSaveTreeItems : Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM * uint32 * Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM[] * uint32 -> int

Public Function GetRelatedSaveTreeItems (saveItem As VSSAVETREEITEM, celt As UInteger, rgSaveTreeItems As VSSAVETREEITEM(), ByRef pcActual As UInteger) As Integer

Parameters

saveItem

VSSAVETREEITEM

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

celt

UInt32

The number of documents to save

rgSaveTreeItems

VSSAVETREEITEM[]

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

pcActual

UInt32

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

Returns

Int32

ErrorCode to indicate success or failure

Implements

GetRelatedSaveTreeItems(VSSAVETREEITEM, UInt32, VSSAVETREEITEM[], UInt32)

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.