IVsUIShell.GetDocumentWindowEnum(IEnumWindowFrames) IVsUIShell.GetDocumentWindowEnum(IEnumWindowFrames) IVsUIShell.GetDocumentWindowEnum(IEnumWindowFrames) Method

Definition

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

public int GetDocumentWindowEnum (out Microsoft.VisualStudio.Shell.Interop.IEnumWindowFrames ppenum);
abstract member GetDocumentWindowEnum :  -> int
Public Function GetDocumentWindowEnum (ByRef ppenum As IEnumWindowFrames) As Integer
Parameters
ppenum
IEnumWindowFrames IEnumWindowFrames IEnumWindowFrames

[out] Pointer to the document window enumerator.

Returns

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