This documentation is archived and is not being maintained.

IVsUIShell.GetDocumentWindowEnum Method

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

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

int GetDocumentWindowEnum (
	out IEnumWindowFrames ppenum
int GetDocumentWindowEnum (
	/** @attribute OutAttribute() */ /** @ref */ IEnumWindowFrames ppenum
JScript does not support passing value-type arguments by reference.



[out] Pointer to the document window enumerator.

Return Value

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

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.