IRAPISession::CeEnumDBVolumes
A version of this page is also available for
4/8/2010
This method enumerates all mounted database volumes on a remote Windows Embedded CE–based device and returns the name for each.
Syntax
BOOL CeEnumDBVolumes (
PCEGUID pceguid,
LPWSTR lpBuf,
DWORD dwNumChars
);
Parameters
- pceguid
[in] To begin enumeration, set this parameter to the value returned by the CREATE_INVALIDGUID macro .
- lpBuf
[out] Pointer to the allocated buffer that receives the database volume names.
- dwNumChars
[in] Specifies the length, in characters, of the buffer.
Return Value
Nonzero indicates success. Zero indicates failure. To get extended error information, call IRAPISession::CeGetLastError and IRAPISession::CeRapiGetError. 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 begin enumeration, set the pceguid parameter to the value returned by the CREATE_INVALIDGUID macro.On successful completion, pceguid and lpBuf are set to the CEGUID and the database volume name of the first of the database volume, respectively. To continue enumeration, call IRAPISession::CeEnumDBVolumes and set the pceguid parameter to the value returned by the previous call. 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 eliminates the need to completely restart the process.
Requirements
| Header | rapi2.h |
| Library | ole32.lib, rapiuuid.lib |
| Windows Embedded CE | Windows Embedded CE 6.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |