IVsUIShell.GetToolWindowEnum Method

Article
03/06/2013

Returns an enumerator that iterates through all of the existing tool windows in the environment.

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

Syntax

'Declaration
Function GetToolWindowEnum ( _
    <OutAttribute> ByRef ppenum As IEnumWindowFrames _
) As Integer

int GetToolWindowEnum(
    out IEnumWindowFrames ppenum
)

int GetToolWindowEnum(
    [OutAttribute] IEnumWindowFrames^% ppenum
)

abstract GetToolWindowEnum : 
        ppenum:IEnumWindowFrames byref -> int

function GetToolWindowEnum(
    ppenum : IEnumWindowFrames
) : int

Parameters

ppenum
Type: Microsoft.VisualStudio.Shell.Interop.IEnumWindowFrames%
[out] Pointer to the tool window enumerator.

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 vsshell.idl:

HRESULT IVsUIShell::GetToolWindowEnum(
   [out] IEnumWindowFrames **ppEnum
);

This method returns an IEnumWindowFrames object, which returns a snapshot of the tool window frames present at the time this method is called. Call this method at or near the time of use.

.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.