ITDirectory::EnumerateDirectoryObjects method (rend.h)

Article
02/22/2024

[Rendezvous IP Telephony Conferencing controls and interfaces are not available for use in Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The RTC Client API provides similar functionality.]

The EnumerateDirectoryObjects method creates an enumeration of directory objects of a given type and name.

Syntax

HRESULT EnumerateDirectoryObjects(
  [in]  DIRECTORY_OBJECT_TYPE DirectoryObjectType,
  [in]  BSTR                  pName,
  [out] IEnumDirectoryObject  **ppEnumObject
);

Parameters

[in] DirectoryObjectType

The DIRECTORY_OBJECT_TYPE criteria for object desired.

[in] pName

Pointer to a BSTR containing the full or partial name of the object. The "*" wildcard is supported.

[out] ppEnumObject

Pointer to receive IEnumDirectoryObject interface pointer for the enumerator of matching objects.

Return value

This method can return one of these values.

Value	Meaning
S_OK	Method succeeded.
RND_NOT_CONNECTED	The ITDirectory::Connect method has not been invoked or did not succeed.
E_NOTIMPL	This method is not implemented.

Remarks

The application must use SysAllocString to allocate memory for the pName parameter and use SysFreeString to free the memory when the variable is no longer needed.

TAPI calls the AddRef method on the IEnumDirectoryObject interface returned by ITDirectory::EnumerateDirectoryObjects. The application must call Release on the IEnumDirectoryObject interface to free resources associated with it.

Requirements

Requirement	Value
Target Platform	Windows
Header	rend.h
DLL	Rend.dll

Share via