CeFindFirstDatabase (RAPI)

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function opens an enumeration context to enable an application to enumerate all databases in the object store on a remote Windows Embedded CE–based device.

Syntax

HANDLE CeFindFirstDatabase(
  DWORD dwDbaseType 
);

Parameters

• dwDbaseType
  [in] The type identifier of the databases to enumerate. If this parameter is zero, all databases are enumerated. This value is application-defined and is set when the database is created using the CeCreateDatabase (RAPI) and CeCreateDatabaseEx (RAPI) methods.

Return Value

A handle to an enumeration context indicates success. INVALID_HANDLE_VALUE indicates failure.

When passed a NULL value in the dwDbaseType parameter, CeFindFirstDatabase returns a handle and sets the last error to ERROR_INVALID_PARAMETER.

To get extended error information, call CeGetLastError and CeRapiGetError. CeGetLastError may return ERROR_OUTOFMEMORY if no memory is available to allocate a database handle.

Remarks

This function only returns the handle to an enumeration context. To begin enumerating databases, an application must call the CeFindNextDatabase (RAPI) function.

Use the CeCloseHandle (RAPI) function to close a handle returned by the CeFindFirstDatabase function.

Requirements

See Also

Reference

RAPI Functions
CeFindFirstDatabase
CeFindNextDatabase (RAPI)
CeCloseHandle (RAPI)