IOleCache::EnumCache

Returns a pointer to an enumeration object that can be used to enumerate the current cache connections.

HRESULT EnumCache(
  IEnumSTATDATA ** ppenumSTATDATA  //Address of output variable that 
                                   // receives the IEnumSTATDATA 
                                   // interface pointer
);
 

Parameter

ppenumSTATDATA
[out] Address of IEnumSTATDATA* pointer variable that receives the interface pointer to the new enumerator object. If *ppenumSTATDATA is NULL, there are currently no cache connections at this time.

Return Values

This method supports the standard return value E_OUTOFMEMORY, as well as the following:

S_OK
The enumerator object is successfully instantiated or there are no cache connections. Check the ppenumSTATDATA parameter to determine which result occurred. If the ppenumSTATDATA parameter is NULL, then there are no cache connections at this time.

Remarks

The enumerator object returned by this method implements the IEnumSTATDATA interface, one of the standard enumerator interfaces that contain the Next, Reset, Clone, and Skip methods. IEnumSTATDATA enumerates the data stored in an array of STATDATA structures containing information about current cache connections.

QuickInfo

  Windows NT: Use version 3.1 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in oleidl.h.

See Also

IEnumXXXX, IEnumSTATDATA, IOleCache::Cache