IVsUIShell.GetDocumentWindowEnum Method (IEnumWindowFrames)

 

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

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

int GetDocumentWindowEnum(
	out IEnumWindowFrames ppenum
)

Parameters

ppenum
Type: Microsoft.VisualStudio.Shell.Interop.IEnumWindowFrames

[out] Pointer to the document window enumerator.

Return Value

Type: System.Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

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.

Return to top
Show: