IVsRunningDocumentTable.GetRunningDocumentsEnum(IEnumRunningDocuments) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enumerates through all documents in the RDT.

public:
 int GetRunningDocumentsEnum([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumRunningDocuments ^ % ppenum);

public:
 int GetRunningDocumentsEnum([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumRunningDocuments ^ &  ppenum);

int GetRunningDocumentsEnum([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IEnumRunningDocuments const & & ppenum);

public int GetRunningDocumentsEnum (out Microsoft.VisualStudio.Shell.Interop.IEnumRunningDocuments ppenum);

abstract member GetRunningDocumentsEnum : IEnumRunningDocuments -> int

Public Function GetRunningDocumentsEnum (ByRef ppenum As IEnumRunningDocuments) As Integer

Parameters

ppenum: IEnumRunningDocuments

[out] Returns an IEnumRunningDocuments interface.

Returns

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.

Applies to