IVsRunningDocumentTable3.GetRelatedSaveTreeItems Method
Retrieves the related save tree items for a document.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assemblies: Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)
Microsoft.VisualStudio.Shell.Interop.11.0 (in Microsoft.VisualStudio.Shell.Interop.11.0.dll)
Syntax
'Declaration
Function GetRelatedSaveTreeItems ( _
cookie As UInteger, _
grfSave As UInteger, _
celt As UInteger, _
<OutAttribute> rgSaveTreeItems As VSSAVETREEITEM() _
) As UInteger
uint GetRelatedSaveTreeItems(
uint cookie,
uint grfSave,
uint celt,
VSSAVETREEITEM[] rgSaveTreeItems
)
unsigned int GetRelatedSaveTreeItems(
[InAttribute] unsigned int cookie,
[InAttribute] unsigned int grfSave,
[InAttribute] unsigned int celt,
[OutAttribute] array<VSSAVETREEITEM>^ rgSaveTreeItems
)
abstract GetRelatedSaveTreeItems :
cookie:uint32 *
grfSave:uint32 *
celt:uint32 *
rgSaveTreeItems:VSSAVETREEITEM[] byref -> uint32
function GetRelatedSaveTreeItems(
cookie : uint,
grfSave : uint,
celt : uint,
rgSaveTreeItems : VSSAVETREEITEM[]
) : uint
Parameters
cookie
Type: System.UInt32[in] Document from which to get the related save tree items.
grfSave
Type: System.UInt32[in] Save options for the document in the running document table (RDT).
celt
Type: System.UInt32[in] Size the related save tree items.
rgSaveTreeItems
Type: array<Microsoft.VisualStudio.Shell.Interop.VSSAVETREEITEM[][out, size_is(celt), length_is(*pcActual)] Array that contains the save options for the tree-view item.
Return Value
Type: System.UInt32
The actual number of related save tree items that was retrieved.
Remarks
If celt is zero and the return value is not null, the number of VSSAVETREEITEM is returned in the return value. If celt is not zero, rgSaveTreeItems must not be null.
The following example shows a common way of using this method (omitting error checks for readability):
hr = pIVsRunningDocumentTable3->GetRelatedSaveTreeItems(cookie, grfSave, 0, NULL, &cExpected);
prgSaveTreeItems = ::CoTaskMemAlloc(cExpected * sizeof(VSSAVETREEITEM));
hr = pIVsRunningDocumentTable3->GetRelatedSaveTreeItems(cookie, grfSave, cExpected, prgSaveTreeItems, &cActual);
.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.