Share via


CeOpenDatabaseEx (RAPI)

This function opens an existing database on any database volume, including mounted databases. CeOpenDatabaseEx (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.

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 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] Pointer to a CENOTIFICATION structure that requests notifications be sent to an identified window. This parameter can be NULL if an application does not need to receive notifications.

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 (RAPI) 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

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

See Also

CeCloseHandle (RAPI), CeCreateDatabaseEx (RAPI), CeReadRecordPropsEx (RAPI), CeSeekDatabase (RAPI), CENOTIFICATION, CREATE_INVALIDGUID

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.