Microsoft Windows CE 3.0  

CeEnumDBVolumes (RAPI)

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function enumerates all mounted database volumes and returns the name for each. CeEnumDBVolumes (RAPI)is a remote application interface, which enables an application running on a desktop computer to make function calls on a Windows CE–based device.

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 CeGetLastErrorinclude 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

  1. The system sets up the process of enumerating all database volumes.
  2. On the first successful completion, pceguidand lpBufare set to the CEGUIDand the database volume name of the first of the database volumes, respectively.

    To continue enumeration

    1. Call CeEnumDBVolumes (RAPI)with the previously returned CEGUID. Continue until an error occurs.
    2. If the return value is ERROR_INSUFFICIENT_BUFFER, reallocate the buffer and use the pceguidthat was returned from the failure to resume the enumeration. This prevents the necessity to completely restart the process.

      Requirements

      Runs On Versions Defined in Include Link to
      Windows CE OS 2.12 and later Rapi.h    

      See Also

      CeGetLastError, CREATE_INVALIDGUID