IVsUIShell.GetDocumentWindowEnum Method

Article
04/22/2008

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
)

function GetDocumentWindowEnum(
    ppenum : IEnumWindowFrames
) : int

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.

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.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via