IVsUIShell.GetDocumentWindowEnum(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 existing document windows in the environment.

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

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

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

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

abstract member GetDocumentWindowEnum : IEnumWindowFrames -> int

Public Function GetDocumentWindowEnum (ByRef ppenum As IEnumWindowFrames) As Integer

Parameters

ppenum: IEnumWindowFrames

[out] Pointer to the document 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::GetDocumentWindowEnum(  
   [out] IEnumWindowFrames **ppEnum  
);

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

Applies to