IVsUIShell.GetToolWindowEnum(IEnumWindowFrames) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int GetToolWindowEnum([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumWindowFrames ^ % ppenum);

public:
 int GetToolWindowEnum([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumWindowFrames ^ &  ppenum);

int GetToolWindowEnum([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumWindowFrames const & & ppenum);

public int GetToolWindowEnum (out Microsoft.VisualStudio.Shell.Interop.IEnumWindowFrames ppenum);

abstract member GetToolWindowEnum : IEnumWindowFrames -> int

Public Function GetToolWindowEnum (ByRef ppenum As IEnumWindowFrames) As Integer

Parameters

ppenum: IEnumWindowFrames

[out] Pointer to the tool window enumerator.

Returns

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.

Applies to