Partager via


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 Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Déclaration
Function GetDocumentWindowEnum ( _
    <OutAttribute> ByRef ppenum As IEnumWindowFrames _
) As Integer
'Utilisation
Dim instance As IVsUIShell
Dim ppenum As IEnumWindowFrames
Dim returnValue As Integer

returnValue = instance.GetDocumentWindowEnum(ppenum)
int GetDocumentWindowEnum(
    out IEnumWindowFrames ppenum
)
int GetDocumentWindowEnum(
    [OutAttribute] IEnumWindowFrames^% ppenum
)
abstract GetDocumentWindowEnum : 
        ppenum:IEnumWindowFrames byref -> int 
function GetDocumentWindowEnum(
    ppenum : IEnumWindowFrames
) : int

Parameters

Return Value

Type: System.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.

.NET Framework Security

See Also

Reference

IVsUIShell Interface

IVsUIShell Members

Microsoft.VisualStudio.Shell.Interop Namespace