This documentation is archived and is not being maintained.

IVsRunningDocumentTable.GetRunningDocumentsEnum Method

Enumerates through all documents in the RDT.

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

int GetRunningDocumentsEnum (
	out IEnumRunningDocuments ppenum
int GetRunningDocumentsEnum (
	/** @attribute OutAttribute() */ /** @ref */ IEnumRunningDocuments ppenum
JScript does not support passing value-type arguments by reference.



[out] Returns an IEnumRunningDocuments interface.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

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.