IVsRunningDocumentTable.GetRunningDocumentsEnum Method

Enumerates through all documents in the RDT.

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

Syntax

'Declaration
Function GetRunningDocumentsEnum ( _
    <OutAttribute> ByRef ppenum As IEnumRunningDocuments _
) As Integer
'Usage
Dim instance As IVsRunningDocumentTable
Dim ppenum As IEnumRunningDocuments
Dim returnValue As Integer

returnValue = instance.GetRunningDocumentsEnum(ppenum)

int GetRunningDocumentsEnum(
    out IEnumRunningDocuments ppenum
)

int GetRunningDocumentsEnum(
    [OutAttribute] IEnumRunningDocuments^% ppenum
)

abstract GetRunningDocumentsEnum : 
        ppenum:IEnumRunningDocuments byref -> int

function GetRunningDocumentsEnum(
    ppenum : IEnumRunningDocuments
) : int

Parameters

ppenum
Type: Microsoft.VisualStudio.Shell.Interop.IEnumRunningDocuments%
[out] Returns an IEnumRunningDocuments interface.

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 IVsRunningDocumentTable::GetRunningDocumentsEnum(
   [out] IEnumRunningDocuments **ppenum
);

The values returned from the IEnumRunningDocuments object are document cookies, the same values that are returned from the FindAndLockDocument and RegisterAndLockDocument methods.

.NET Framework Security

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.