CeOpenDatabaseEx

  • Article

This function opens an existing database on any database volume, including mounted databases. CeOpenDatabaseEx 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_(HANDLE) CeOpenDatabaseEx( 
  PCEGUID pceguid, 
  PCEOID poid,
  LPWSTR lpszName, 
  CEPROPID propid, 
  DWORD dwFlags,
  CENOTIFYREQUEST * pRequest 
);

Parameters

  • pceguid
    [in] Pointer to the CEGUID that contains the globally unique identifier (GUID) of a mounted database. If pceguid equals CREATE_INVALIDGUID, then poid is ignored, and the object store and all mounted databases are searched for a database whose name matches lpszName. The search is completed when the first match is located.

  • poid
    [in, out] Pointer to the object identifier of the database to be opened. To open a database by name, set the value pointed to by poid to zero, set lpszName to the database name, and set pceguid to the database volume.

  • lpszName
    [in] Long pointer to the null-terminated string that contains the name of the database to be opened. This is used along with pceguid to specify the database if the value pointed to by poid is zero. If the value pointed to by poid is nonzero, lpszName is ignored.

  • propid
    [in] Property identifier of the primary sort key for the database. All subsequent calls to CeSeekDatabase (RAPI) assume this sort order. This parameter can be zero if the sort order is not important.

  • dwFlags
    [in] Specifies an action flag. It is one of the following flags.

    Value Description
    CEDB_AUTOINCREMENT Current seek position is automatically incremented with each call to CeReadRecordPropsEx (RAPI).
    0 Current seek position is not incremented with each call to CeReadRecordPropsEx (RAPI).

  • pRequest
    [in] Not supported; set to NULL.

Return Values

A handle to the open database indicates success. INVALID_HANDLE_VALUE indicates failure. To get extended error information, call CeGetLastError. Possible values for CeGetLastError include the following:

  • ERROR_INVALID_PARAMETER
    A parameter was invalid.
  • ERROR_FILE_NOT_FOUND
    No database exists with the specified name. This error code applies only if the value pointed to by poid was set to NULL, when the function was called.
  • ERROR_NOT_ENOUGH_MEMORY
    No memory was available to allocate the database handle.

Remarks

An application must use the CeCloseHandle function to close the handle returned by the CeOpenDatabaseEx (RAPI) function.

Changes to Windows CE databases are committed after each individual call, not when opening and closing a database.

Requirements

Smartphone Platforms: Smartphone 2002 and later
OS Versions: Windows CE 3.0 and later
Header: rapi.h
Library: rapi.lib

See Also

CeCreateDatabaseEx, CeReadRecordPropsEx, CeSeekDatabase

Last updated on Friday, April 22, 2005

© 2005 Microsoft Corporation. All rights reserved.

Send feedback on this topic to the authors.