DesignerDocDataService::IVsHasRelatedSaveItems::GetRelatedSaveTreeItems Method (VSSAVETREEITEM, UInt32, array<VSSAVETREEITEM>^, UInt32)

 

Coordinates save operations across the documents maintained by this service.

Namespace:   Microsoft.VisualStudio.Shell.Design.Serialization
Assembly:  Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

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

Parameters

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

A VSSAVETREEITEM structure that specifies how the items are to be saves.

celt
Type: System::UInt32

The number of documents to save.

rgSaveTreeItems
Type: array<Microsoft.VisualStudio.Shell.Interop::VSSAVETREEITEM>^

An array of VSSAVETREEITEM structures.

pcActual
Type: System::UInt32

[out] Returns the actual number of documents saved.

Return Value

Type: System::Int32

If celt is either 0 or equal to pcActual, S_OK; if not, S_FALSE. If saveItem doesn't specify to close the documents, returns E_NOTIMPL.

If celt is 0, no documents will be saved, and pcActual will contain the number of documents that should be saved. The most common usage of this method is to call it once to get the number of documents to save, and a second time (with the old pcActual as the new celt) to save the documents.

Return to top
Show: