CeEnumDBVolumes (RAPI) (Windows CE 5.0)

Send Feedback

This function enumerates all mounted database volumes and returns the name for each.

CeEnumDBVolumes is a remote application interface (RAPI), 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 CeGetLastError include the following.

Value Description
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, pceguid and lpBuf are set to the CEGUID and 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 pceguid that was returned from the failure to resume the enumeration. This prevents the necessity to completely restart the process.

Requirements

OS Versions: Windows CE 2.12 and later.
Header: Rapi.h.
Link Library: Rapi.lib.

See Also

RAPI Functions | CeGetLastError | CREATE_INVALIDGUID

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.