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
int GetRunningDocumentsEnum(
    out IEnumRunningDocuments ppenum
)
int GetRunningDocumentsEnum(
    [OutAttribute] IEnumRunningDocuments^% ppenum
)
abstract GetRunningDocumentsEnum : 
        ppenum:IEnumRunningDocuments byref -> int
function GetRunningDocumentsEnum(
    ppenum : IEnumRunningDocuments
) : 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 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

See Also

Reference

IVsRunningDocumentTable Interface

Microsoft.VisualStudio.Shell.Interop Namespace