Share via

CeEnumDBVolumes

  • Article

This function enumerates all mounted database volumes and returns the name for each. CeEnumDBVolumes is a RAPI that enables an application that is running on a desktop computer to make function calls on a Microsoft® Windows® CE–based device.

STDAPI_(BOOL) CeEnumDBVolumes (
  PCEGUID pceguid, 
  LPWSTR lpBuf,
  DWORD dwNumChars 
);

Parameters

  • pceguid
    [in] To begin enumeration, set this parameter to the value returned by CREATE_INVALIDGUID.
  • lpBuf
    [out] Pointer to the allocated buffer that receives the database volume names.
  • dwNumChars
    [in] Specifies the length, in characters, of the buffer.

Return Values

TRUE indicates success. FALSE indicates failure. To get extended error information, call CeGetLastError. Possible values for CeGetLastError include the following:

  • ERROR_INVALID_PARAMETER
    One of the parameters is invalid.
  • ERROR_NO_MORE_ITEMS
    There are no more mounted volumes to enumerate.
  • ERROR_INSUFFICIENT_BUFFER
    The specified buffer was not large enough.

Remarks

To enumerate all mounted volumes.

The system sets up the process of enumerating all database volumes.

On the first successful completion, pceguid and lpBuf are set to the CEGUID and the database volume name of the first of the database volumes, respectively.

To continue enumeration.

Call CeEnumDBVolumes (RAPI) with the previously returned CEGUID. Continue until an error occurs.

If the return value is ERROR_INSUFFICIENT_BUFFER, reallocate the buffer and use the pceguid that was returned from the failure to resume the enumeration. This prevents the necessity to completely restart the process.

Requirements

Pocket PC Platforms: Pocket PC 2000 and later
OS Versions: Windows CE 3.0 and later
Header: rapi.h
Library: rapi.lib

Send feedback on this topic to the authors.

© 2005 Microsoft Corporation. All rights reserved.